Files
plezy/lib/models/external_player_models.dart
T

437 lines
15 KiB
Dart
Raw Normal View History

2026-02-11 14:59:22 +01:00
import 'dart:io';
import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart';
2026-02-11 14:59:22 +01:00
import 'package:url_launcher/url_launcher.dart';
import '../utils/app_logger.dart';
typedef PlayerLauncher = Future<bool> Function(String url);
enum CustomPlayerType { command, urlScheme }
/// Host lookups behind [KnownPlayers.getForCurrentPlatform], split out so tests
/// can answer them without touching the real machine.
class PlayerInstallProbe {
const PlayerInstallProbe();
/// Drives which detectors run. Values match [Platform.operatingSystem].
String get operatingSystem => Platform.operatingSystem;
Map<String, String> get environment => Platform.environment;
Future<ProcessResult> run(String executable, List<String> arguments) => Process.run(executable, arguments);
Future<bool> fileExists(String path) => File(path).exists();
/// macOS Launch Services lookup — the database `open -a` resolves through.
/// Spotlight is deliberately not consulted: an empty `mdfind` result also
/// means indexing is off or incomplete, which would hide installed players.
Future<bool> applicationInstalled(String bundleId) async {
const channel = MethodChannel('com.plezy/app_lookup');
return await channel.invokeMethod<bool>('isApplicationInstalled', {'bundleId': bundleId}) ?? false;
}
Future<bool> schemeHasHandler(String scheme) => canLaunchUrl(Uri.parse(scheme));
}
2026-02-11 14:59:22 +01:00
class ExternalPlayer {
final String id;
final String name;
final String? iconAsset;
final bool isAvailable;
final PlayerLauncher launch;
final bool isCustom;
final String? customValue; // Only for custom player serialization
final CustomPlayerType? customType;
ExternalPlayer({
required this.id,
required this.name,
this.iconAsset,
this.isAvailable = true,
required this.launch,
this.isCustom = false,
this.customValue,
this.customType,
});
factory ExternalPlayer.custom({
required String id,
required String name,
required String value,
required CustomPlayerType type,
}) {
return ExternalPlayer(
id: id,
name: name,
isCustom: true,
customValue: value,
customType: type,
launch: (url) => _launchCustom(value, url, type),
);
}
factory ExternalPlayer.fromJson(Map<String, dynamic> json) {
final id = json['id'] as String;
final known = KnownPlayers.findById(id);
if (known != null) return known;
return ExternalPlayer.custom(
id: id,
name: json['name'] as String,
value: json['customValue'] as String? ?? '',
type: json['customType'] == 'urlScheme' ? CustomPlayerType.urlScheme : CustomPlayerType.command,
);
}
Map<String, dynamic> toJson() => {
'id': id,
'name': name,
if (isCustom) 'isCustom': true,
if (customValue != null) 'customValue': customValue,
if (customType != null) 'customType': customType == CustomPlayerType.urlScheme ? 'urlScheme' : 'command',
};
@override
bool operator ==(Object other) =>
identical(this, other) || other is ExternalPlayer && runtimeType == other.runtimeType && id == other.id;
@override
int get hashCode => id.hashCode;
}
2026-02-15 03:14:04 +01:00
Future<bool> _launchWithUrl(String url) {
2026-02-11 14:59:22 +01:00
return launchUrl(Uri.parse(url), mode: LaunchMode.externalApplication);
}
2026-06-11 08:35:19 +02:00
Future<bool> _launchAndroidIntent(String url, {required String package, bool fallbackToUrl = true}) async {
2026-02-11 14:59:22 +01:00
final intentUri = Uri.parse(
'intent:$url#Intent;'
'action=android.intent.action.VIEW;'
'type=video/*;'
'package=$package;'
'end',
);
try {
return await launchUrl(intentUri, mode: LaunchMode.externalApplication);
} catch (_) {
2026-06-11 08:35:19 +02:00
return fallbackToUrl ? _launchWithUrl(url) : false;
2026-02-11 14:59:22 +01:00
}
}
2026-06-11 08:35:19 +02:00
Future<bool> _launchAndroidIntentCandidates(String url, Iterable<String> packages) async {
for (final package in packages) {
if (await _launchAndroidIntent(url, package: package, fallbackToUrl: false)) return true;
}
return _launchWithUrl(url);
}
2026-02-11 14:59:22 +01:00
Future<bool> _launchUrlScheme(String scheme, String url) async {
final playerUrl = scheme.contains('url=') ? '$scheme${Uri.encodeComponent(url)}' : '$scheme$url';
final uri = Uri.parse(playerUrl);
if (await canLaunchUrl(uri)) {
return launchUrl(uri, mode: LaunchMode.externalApplication);
}
return false;
}
Future<bool> _launchMacApp(String appName, String url) async {
try {
await Process.start('open', ['-a', appName, url], mode: ProcessStartMode.detached);
return true;
} catch (e) {
appLogger.w('Failed to launch $appName via open -a', error: e);
return false;
}
}
Future<bool> _launchCommand(String command, String url) async {
try {
final result = await Process.start(command, [url], mode: ProcessStartMode.detached);
appLogger.d('Launched $command with PID: ${result.pid}');
return true;
} catch (e) {
appLogger.w('Failed to launch $command', error: e);
return false;
}
}
Future<bool> _launchCommandCandidates(Iterable<String> commands, String url) async {
final commandList = commands.toList(growable: false);
Object? lastError;
for (final command in commandList) {
try {
final result = await Process.start(command, [url], mode: ProcessStartMode.detached);
appLogger.d('Launched $command with PID: ${result.pid}');
return true;
} catch (e) {
lastError = e;
appLogger.d('Failed to launch $command', error: e);
}
}
appLogger.w('Failed to launch any of: ${commandList.join(', ')}', error: lastError);
return false;
}
List<String> _windowsVlcCommandCandidates(Map<String, String> environment) {
final candidates = <String>['vlc'];
void addInstallPath(String? programFilesDir) {
final trimmed = programFilesDir?.trim();
if (trimmed == null || trimmed.isEmpty) return;
final root = trimmed.replaceFirst(RegExp(r'[\\/]+$'), '');
candidates.add('$root\\VideoLAN\\VLC\\vlc.exe');
}
addInstallPath(environment['ProgramW6432']);
addInstallPath(environment['ProgramFiles']);
addInstallPath(environment['ProgramFiles(x86)']);
addInstallPath(r'C:\Program Files');
addInstallPath(r'C:\Program Files (x86)');
final seen = <String>{};
return [
for (final candidate in candidates)
if (seen.add(candidate.toLowerCase())) candidate,
];
}
Future<bool> _launchWindowsVlc(String url) {
return _launchCommandCandidates(_windowsVlcCommandCandidates(Platform.environment), url);
}
2026-02-11 14:59:22 +01:00
Future<bool> _launchCustom(String value, String url, CustomPlayerType type) async {
if (type == CustomPlayerType.urlScheme) {
return _launchUrlScheme(value, url);
}
// Command type
if (Platform.isAndroid) {
return _launchAndroidIntent(url, package: value);
} else if (Platform.isMacOS) {
// Try PATH first (e.g. mpv), fall back to open -a (e.g. VLC)
if (await _launchCommand(value, url)) return true;
return _launchMacApp(value, url);
} else {
return _launchCommand(value, url);
}
}
class KnownPlayers {
static final systemDefault = ExternalPlayer(id: 'system_default', name: 'System Default', launch: _launchWithUrl);
2026-06-11 08:35:19 +02:00
static const _androidPackageMap = <String, List<String>>{
'vlc': ['org.videolan.vlc'],
'mpv': ['is.xyz.mpv'],
'mx_player': ['com.mxtech.videoplayer.ad', 'com.mxtech.videoplayer.pro'],
'just_player': ['com.brouken.player'],
};
static List<String> _androidPackageCandidatesForId(String id) {
return _androidPackageMap[id] ?? const [];
}
static List<String> androidPackageCandidates(ExternalPlayer player) {
final knownPackages = _androidPackageCandidatesForId(player.id);
if (knownPackages.isNotEmpty) return knownPackages;
if (player.isCustom && player.customType == CustomPlayerType.command) {
final package = player.customValue?.trim();
return package == null || package.isEmpty ? const [] : [package];
}
return const [];
}
2026-02-11 14:59:22 +01:00
static final _allPlayers = <ExternalPlayer>[
systemDefault,
ExternalPlayer(
id: 'vlc',
name: 'VLC',
iconAsset: 'assets/player_icons/vlc.svg',
isAvailable: Platform.isAndroid || Platform.isIOS || Platform.isMacOS || Platform.isLinux || Platform.isWindows,
2026-02-15 03:14:04 +01:00
launch: (url) {
2026-06-11 08:35:19 +02:00
if (Platform.isAndroid) return _launchAndroidIntentCandidates(url, _androidPackageCandidatesForId('vlc'));
2026-02-11 14:59:22 +01:00
if (Platform.isIOS) return _launchUrlScheme('vlc://', url);
if (Platform.isMacOS) return _launchMacApp('VLC', url);
if (Platform.isWindows) return _launchWindowsVlc(url);
2026-02-11 14:59:22 +01:00
return _launchCommand('vlc', url);
},
),
ExternalPlayer(
id: 'mpv',
name: 'mpv',
iconAsset: 'assets/player_icons/mpv.svg',
isAvailable: Platform.isAndroid || Platform.isMacOS || Platform.isLinux || Platform.isWindows,
2026-02-15 03:14:04 +01:00
launch: (url) {
2026-06-11 08:35:19 +02:00
if (Platform.isAndroid) return _launchAndroidIntentCandidates(url, _androidPackageCandidatesForId('mpv'));
2026-02-11 14:59:22 +01:00
return _launchCommand('mpv', url);
},
),
ExternalPlayer(
id: 'iina',
name: 'IINA',
iconAsset: 'assets/player_icons/iina.png',
isAvailable: Platform.isMacOS,
launch: (url) => _launchUrlScheme('iina://weblink?url=', url),
),
ExternalPlayer(
id: 'mx_player',
name: 'MX Player',
iconAsset: 'assets/player_icons/mx_player.svg',
isAvailable: Platform.isAndroid,
2026-06-11 08:35:19 +02:00
launch: (url) => _launchAndroidIntentCandidates(url, _androidPackageCandidatesForId('mx_player')),
2026-02-11 14:59:22 +01:00
),
ExternalPlayer(
id: 'just_player',
name: 'Just Player',
iconAsset: 'assets/player_icons/just_player.png',
isAvailable: Platform.isAndroid,
2026-06-11 08:35:19 +02:00
launch: (url) => _launchAndroidIntentCandidates(url, _androidPackageCandidatesForId('just_player')),
2026-02-11 14:59:22 +01:00
),
ExternalPlayer(
id: 'infuse',
name: 'Infuse',
iconAsset: 'assets/player_icons/infuse.png',
isAvailable: Platform.isIOS,
launch: (url) => _launchUrlScheme('infuse://x-callback-url/play?url=', url),
),
ExternalPlayer(
id: 'potplayer',
name: 'PotPlayer',
iconAsset: 'assets/player_icons/potplayer.png',
isAvailable: Platform.isWindows,
launch: (url) async {
if (await _launchUrlScheme('potplayer://', url)) return true;
return _launchCommand('PotPlayerMini64', url);
},
),
ExternalPlayer(
id: 'celluloid',
name: 'Celluloid',
iconAsset: 'assets/player_icons/celluloid.svg',
isAvailable: Platform.isLinux,
2026-02-11 14:59:22 +01:00
launch: (url) => _launchCommand('celluloid', url),
),
];
/// Host lookups used to decide whether a supported player is actually
/// installed. Overridden in tests; production talks to the real process,
/// filesystem and URL-handler APIs.
@visibleForTesting
static PlayerInstallProbe probe = const PlayerInstallProbe();
static Future<List<ExternalPlayer>>? _installedPlayers;
/// Players supported on this platform, minus the ones we can positively tell
/// are not installed.
///
/// Detection forks `sh` or `where.exe` and calls out over platform channels,
/// so it is asynchronous and memoised: it runs once per process and a player
/// installed while Plezy is running only appears after a restart. Android is
/// the one platform left unprobed — where there is no reliable check the
/// player stays listed, because hiding a working player is worse than
/// listing a missing one.
static Future<List<ExternalPlayer>> getForCurrentPlatform() {
return _installedPlayers ??= _resolveForCurrentPlatform();
}
@visibleForTesting
static void resetForTesting() {
probe = const PlayerInstallProbe();
_installedPlayers = null;
}
static Future<List<ExternalPlayer>> _resolveForCurrentPlatform() async {
final supported = [
for (final player in _allPlayers)
if (player.isAvailable) player,
];
// Each detector must answer the same question its launcher asks, so a
// listed player is one we can actually start.
final detectors = <String, Future<bool> Function()>{};
switch (probe.operatingSystem) {
case 'linux':
detectors['vlc'] = () => _posixCommandExists('vlc');
detectors['mpv'] = () => _posixCommandExists('mpv');
detectors['celluloid'] = () => _posixCommandExists('celluloid');
case 'macos':
detectors['vlc'] = () => probe.applicationInstalled('org.videolan.vlc');
detectors['iina'] = () => probe.applicationInstalled('com.colliderli.iina');
detectors['mpv'] = () => _posixCommandExists('mpv');
case 'windows':
detectors['vlc'] = _windowsVlcExists;
detectors['mpv'] = () => _windowsCommandExists('mpv');
detectors['potplayer'] = _windowsPotPlayerExists;
case 'ios':
// Same predicate _launchUrlScheme gates on, so detection can never
// hide a player the handoff would have reached. Both schemes are
// declared in LSApplicationQueriesSchemes.
detectors['vlc'] = () => probe.schemeHasHandler('vlc://');
detectors['infuse'] = () => probe.schemeHasHandler('infuse://');
}
if (detectors.isEmpty) return supported;
final ids = detectors.keys.toList(growable: false);
final found = await Future.wait(ids.map((id) => _detect(id, detectors[id]!)));
final missing = <String>{
for (var i = 0; i < ids.length; i++)
if (!found[i]) ids[i],
};
if (missing.isEmpty) return supported;
return [
for (final player in supported)
if (!missing.contains(player.id)) player,
];
}
/// Runs one detector, failing open: a probe that blows up must not hide a
/// player the user may well have installed.
static Future<bool> _detect(String id, Future<bool> Function() detector) async {
try {
return await detector();
} catch (e, stackTrace) {
appLogger.w('External player detection failed for $id; listing it anyway', error: e, stackTrace: stackTrace);
return true;
}
}
/// True when [command] resolves on `PATH`. The shell defers to the kernel, so
/// permission classes, ACLs and `noexec` mounts are honoured exactly as they
/// will be when [Process.start] execs the command.
static Future<bool> _posixCommandExists(String command) async {
final result = await probe.run('sh', ['-c', r'command -v "$1" >/dev/null 2>&1', 'plezy-command-probe', command]);
return result.exitCode == 0;
}
static Future<bool> _windowsCommandExists(String command) async {
final result = await probe.run('where.exe', [command]);
return result.exitCode == 0;
}
/// Mirrors [_launchWindowsVlc]: any of the concrete install paths, or `vlc`
/// on `PATH`.
static Future<bool> _windowsVlcExists() async {
for (final candidate in _windowsVlcCommandCandidates(probe.environment)) {
if (candidate.contains(r'\') && await probe.fileExists(candidate)) return true;
}
return _windowsCommandExists('vlc');
}
/// Mirrors the PotPlayer launcher: the registered `potplayer://` handler, or
/// the executable on `PATH`.
static Future<bool> _windowsPotPlayerExists() async {
if (await probe.schemeHasHandler('potplayer://')) return true;
return _windowsCommandExists('PotPlayerMini64');
2026-02-11 14:59:22 +01:00
}
/// Find a known player by ID
static ExternalPlayer? findById(String id) {
try {
return _allPlayers.firstWhere((p) => p.id == id);
} catch (_) {
return null;
}
}
}