#!/usr/bin/perl
-use v5.32;
+use strict;
+use warnings;
+use utf8::all;
-use App::MPD::Feeder::Options;
-use Getopt::Long ();
+use App::MPD::Feeder;
use Log::Any qw($log);
use Log::Any::Adapter Stderr => log_level => 'error';
-use Object::Pad;
-use Syntax::Keyword::Try;
-class Feeder {
- has $cfg_file :reader;
- has $opt :reader;
- has $db;
- has $db_generation;
- has $db_needs_update :writer = 1;
- has $mpd :reader;
-
-use constant DEFAULT_CONFIG_FILE => '/etc/mpd-feeder/mpd-feeder.conf';
-
-use DBD::Pg;
-use DBI;
-use Log::Any qw($log);
-use IO::Async::Signal;
-use Net::Async::MPD;
-
- ADJUST {
- Getopt::Long::Configure('pass_through');
- Getopt::Long::GetOptions('cfg|config=s' => \$cfg_file);
- Getopt::Long::Configure('no_pass_through');
-
- $cfg_file //= DEFAULT_CONFIG_FILE if -e DEFAULT_CONFIG_FILE;
-
- $self->configure;
-
- $db_needs_update = 0 if $opt->skip_db_update;
- }
-
- method configure {
- my $new_opt = App::MPD::Feeder::Options->new;
-
- $new_opt->parse_config_file($cfg_file) if $cfg_file;
-
- $new_opt->parse_command_line;
-
- Log::Any::Adapter->set( Stderr => log_level => $new_opt->log_level );
-
- $opt = $new_opt;
- }
-
- method connect_mpd {
- return if $mpd;
-
- my %conn = ( auto_connect => 1 );
- $conn{host} = $opt->mpd_host if $opt->mpd_host;
- $conn{port} = $opt->mpd_port if $opt->mpd_port;
-
- $mpd = Net::Async::MPD->new(%conn);
-
- $mpd->loop->add(
- IO::Async::Signal->new(
- name => 'HUP',
- on_receipt => sub {
- $log->debug("SIGHUP received. Stopping loop");
- $mpd->loop->stop('reload');
- },
- )
- );
-
- $mpd->loop->add(
- IO::Async::Signal->new(
- name => 'USR1',
- on_receipt => sub {
- $log->debug("SIGUSR1 received. Dumping configuration to STDERR");
- my $old = select \*STDERR;
- try {
- $opt->dump;
- }
- finally {
- select $old;
- }
- },
- )
- );
- }
-
- method connect_db {
- return if $db;
-
- $db = DBI->connect( "dbi:Pg:dbname=" . $opt->db_path,
- $opt->db_user, $opt->db_password,
- { RaiseError => 1, PrintError => 0, AutoCommit => 1 } );
-
- $log->info( "Connected to database " . $opt->db_path );
- $db_generation = $self->db_get_option('generation');
- $log->debug("DB generation is $db_generation");
- $self->update_db;
- }
-
- method db_get_option($name) {
- my $sth = $db->prepare_cached("select $name from options");
- $sth->execute;
- my @result = $sth->fetchrow_array;
- $sth->finish;
- undef $sth;
-
- return $result[0];
- }
-
- method db_set_option( $name, $value ) {
- my $sth = $db->prepare_cached("update options set $name = ?");
- $sth->execute($value);
- }
-
- method db_store_song($song, $artist, $album) {
- return unless length($song) and length($artist) and length($album);
-
- $db->prepare_cached(
- <<'SQL')->execute( $song, $artist, $album, $db_generation );
-INSERT INTO songs(path, artist, album, generation)
-VALUES($1, $2, $3, $4)
-ON CONFLICT ON CONSTRAINT songs_pkey DO
-UPDATE SET artist = $2
- , album = $3
- , generation = $4
-SQL
- $db->prepare_cached(<<'SQL')->execute( $artist, $album, $db_generation );
-INSERT INTO albums(artist, album, generation)
-VALUES($1, $2, $3)
-ON CONFLICT ON CONSTRAINT albums_pkey DO
-UPDATE SET generation = $3
-SQL
- $db->prepare_cached(<<'SQL')->execute( $artist, $db_generation );
-INSERT INTO artists(artist, generation)
-VALUES($1, $2)
-ON CONFLICT ON CONSTRAINT artists_pkey DO
-UPDATE SET generation = $2
-SQL
- }
-
- method db_remove_stale_entries {
- my $sth =
- $db->prepare_cached('DELETE FROM songs WHERE generation <> ?');
- $sth->execute($db_generation);
- $log->debug( sprintf( "Deleted %d stale songs", $sth->rows ) );
-
- $sth = $db->prepare_cached('DELETE FROM albums WHERE generation <> ?');
- $sth->execute($db_generation);
- $log->debug( sprintf( "Deleted %d stale albums", $sth->rows ) );
-
- $sth =
- $db->prepare_cached('DELETE FROM artists WHERE generation <> ?');
- $sth->execute($db_generation);
- $log->debug( sprintf( "Deleted %d stale artists", $sth->rows ) );
- }
-
- method db_note_song_qeued($item) {
- $db->prepare_cached(
- 'UPDATE songs SET last_queued=current_timestamp WHERE path=?')
- ->execute( $item->{song} );
- $db->prepare_cached(
- 'UPDATE artists SET last_queued=CURRENT_TIMESTAMP WHERE artist=?')
- ->execute( $item->{artist} );
- $db->prepare_cached(
- 'UPDATE albums SET last_queued=CURRENT_TIMESTAMP WHERE artist=? AND album=?'
- )->execute( $item->{artist}, $item->{album} );
- }
-
- method update_db($force = undef) {
- if (!$db_needs_update and !$force) {
- $log->debug("Skipping DB update");
- return;
- }
-
- $log->info('Updating song database');
- $self->connect_mpd;
- $self->connect_db;
-
- my $rows = $mpd->send('listallinfo')->get;
- try {
- $db->begin_work;
-
- $db_generation++;
-
- my $song_count;
-
- foreach my $entry (@$rows) {
- next unless exists $entry->{file};
- $self->db_store_song( $entry->{file},
- $entry->{AlbumArtist} // $entry->{Artist},
- $entry->{Album} );
- $song_count++;
- }
-
- $log->info("Updated data about $song_count songs");
-
- $self->db_remove_stale_entries;
-
- $self->db_set_option( generation => $db_generation );
-
- $db->commit;
-
- $db_needs_update = 0;
- }
- catch {
- my $err = $@;
-
- $db_generation--;
-
- $db->rollback;
-
- die $err;
- }
- }
-
- method db_find_suitable_songs($num) {
- $self->connect_db;
- $self->update_db;
-
- my @result;
- my $sql = <<SQL;
-SELECT s.path, s.artist, s.album
-FROM songs s
-JOIN artists ar ON ar.artist=s.artist
-JOIN albums al ON al.album=s.album AND al.artist=s.artist
-WHERE (s.last_queued IS NULL OR s.last_queued < CURRENT_TIMESTAMP - (? || ' seconds')::interval)
- AND (ar.last_queued IS NULL OR ar.last_queued < CURRENT_TIMESTAMP - (? || ' seconds')::interval)
- AND (al.last_queued IS NULL OR al.last_queued < CURRENT_TIMESTAMP - (? || ' seconds')::interval)
- AND NOT EXISTS (SELECT 1 FROM unwanted_artists uar WHERE uar.artist = s.artist)
- AND NOT EXISTS (SELECT 1 FROM unwanted_albums ual WHERE ual.album = s.album)
-ORDER BY random()
-LIMIT ?
-SQL
- my @params = (
- $opt->min_song_interval, $opt->min_artist_interval,
- $opt->min_album_interval, $num,
- );
- my $sth = $db->prepare_cached($sql);
- $sth->execute(@params);
- while ( my @row = $sth->fetchrow_array ) {
- push @result,
- { song => $row[0], artist => $row[1], album => $row[2] };
- }
- undef $sth;
-
- if (scalar(@result) == $num and $log->is_debug) {
- $sql =~ s/^SELECT .+$/SELECT COUNT(DISTINCT s.path)/m;
- $sql =~ s/^ORDER BY .+$//m;
- $sql =~ s/^LIMIT .+$//m;
- $log->debug($sql);
- my $sth = $db->prepare_cached($sql);
- pop @params;
- $sth->execute(@params);
- my $count = ($sth->fetchrow_array)[0];
- $sth->finish;
-
- $sth = $db->prepare_cached('SELECT COUNT(*) FROM songs');
- $sth->execute;
- my $total = ($sth->fetchrow_array)[0];
- $log->debug(
- sprintf(
- "Number of songs meeting the criteria: %d out of total %d (%5.2f%%)",
- $count, $total, 100.0 * $count / $total
- )
- );
- $sth->finish;
-
- $sql = <<SQL;
-SELECT COUNT(*)
-FROM songs s
-WHERE (s.last_queued IS NULL OR s.last_queued < CURRENT_TIMESTAMP - (? || ' seconds')::interval)
-UNION
-SELECT COUNT(*)
-FROM songs
-SQL
- $sth = $db->prepare_cached($sql);
- $sth->execute($opt->min_song_interval);
- $count = ($sth->fetchrow_array)[0];
- $total = ($sth->fetchrow_array)[0];
- $sth->finish;
-
- $log->debug(
- sprintf(
- "Number of songs not queued soon: %d out of total %d (%5.2f%%)",
- $count, $total, 100.0 * $count / $total
- )
- );
- $sth->finish;
-
- $sql = <<SQL;
-SELECT COUNT(*)
-FROM artists ar
-WHERE (ar.last_queued IS NULL OR ar.last_queued < CURRENT_TIMESTAMP - (? || ' seconds')::interval)
-UNION
-SELECT COUNT(*)
-FROM artists
-SQL
- $sth = $db->prepare_cached($sql);
- $sth->execute($opt->min_artist_interval);
- $count = ($sth->fetchrow_array)[0];
- $total = ($sth->fetchrow_array)[0];
- $log->debug(
- sprintf(
- "Number of artists not queued soon: %d out of total %d (%5.2f%%)",
- $count, $total, 100.0 * $count / $total
- )
- );
- $sth->finish;
-
- $sql = <<SQL;
-SELECT COUNT(*)
-FROM albums al
-WHERE (al.last_queued IS NULL OR al.last_queued < CURRENT_TIMESTAMP - (? || ' seconds')::interval)
-UNION
-SELECT COUNT(*)
-FROM albums
-SQL
- $sth = $db->prepare_cached($sql);
- $sth->execute($opt->min_album_interval);
- $count = ($sth->fetchrow_array)[0];
- $total = ($sth->fetchrow_array)[0];
- $log->debug(
- sprintf(
- "Number of albums not queued soon: %d out of total %d (%5.2f%%)",
- $count, $total, 100.0 * $count / $total
- )
- );
- $sth->finish;
-
- undef $sth;
- }
-
- return @result;
- }
-
- method db_add_unwanted_artist($artist) {
- $self->connect_db;
-
- try {
- $db->do(
- <<'SQL',
-INSERT INTO unwanted_artists(artist, generation)
-VALUES($1, $2)
-SQL
- undef, $artist, $db_generation
- );
- return 1;
- }
- catch {
- my $err = $@;
-
- $log->debug("PostgreSQL error: $err");
- $log->debug( "SQLSTATE = " . $db->state );
- return 0 if $db->state eq '23505';
-
- die $err;
- }
- }
-
- method db_del_unwanted_artist($artist) {
- $self->connect_db;
-
- return 1 == $db->do(
- <<'SQL',
-DELETE FROM unwanted_artists
-WHERE artist = $1
-SQL
- undef, $artist
- );
- }
-
- method queue_songs($num = undef, $callback = undef) {
- if (!defined $num) {
- $self->connect_mpd;
- $mpd->send('playlist')->on_done(
- sub {
- my $present = scalar @{ $_[0] };
-
- $log->notice( "Playlist contains $present songs. Wanted: "
- . $opt->target_queue_length );
- if ( $present < $opt->target_queue_length ) {
- $self->queue_songs(
- $opt->target_queue_length - $present, $callback );
- }
- else {
- $callback->() if $callback;
- }
- }
- );
-
- return;
- }
-
- my @list = $self->db_find_suitable_songs($num);
-
- die "Found no suitable songs" unless @list;
-
- if ( @list < $num ) {
- $log->warn(
- sprintf(
- 'Found only %d suitable songs instead of %d',
- scalar(@list), $num
- )
- );
- }
-
- $log->info("About to add $num songs to the playlist");
-
- my @paths;
- for my $song (@list) {
- my $path = $song->{song};
- $path =~ s/"/\\"/g;
- push @paths, $path;
- }
-
- $log->debug( "Adding " . join( ', ', map {"«$_»"} @paths ) );
- my @commands;
- for (@paths) {
- push @commands, [ add => "\"$_\"" ];
- }
- $self->connect_mpd;
- my $f = $mpd->send( \@commands );
- $f->on_fail( sub { die @_ } );
- $f->on_done(
- sub {
- $self->db_note_song_qeued($_) for @list;
- $callback->(@_) if $callback;
- }
- );
- }
-
- method prepare_to_wait_idle {
- $log->trace('declaring idle mode');
- $mpd->send('idle database playlist')->on_done(
- sub {
- my $result = shift;
-
- if ( $result->{changed} eq 'database' ) {
- $db_needs_update = 1;
- $self->prepare_to_wait_idle;
- }
- elsif ( $result->{changed} eq 'playlist' ) {
- $self->queue_songs( undef,
- sub { $self->prepare_to_wait_idle } );
- }
- else {
- use JSON;
- $log->warn(
- "Unknown result from idle: " . to_json($result) );
- $self->prepare_to_wait_idle;
- }
- }
- );
- }
-
- method run {
- $mpd->on(
- close => sub {
- die "Connection to MPD lost";
- }
- );
-
- $self->prepare_to_wait_idle;
- }
-
- method stop {
- undef $mpd;
-
- if ($db) {
- if ($db->{ActiveKids}) {
- $log->warn("$db->{ActiveKids} active DB statements");
- for my $st ( @{ $db->{ChildHandles} } ) {
- next unless $st->{Active};
- while(my($k,$v) = each %$st) {
- $log->debug("$k = ".($v//'<NULL>'));
- }
- }
- }
-
- $db->disconnect;
- undef $db;
- }
- }
+{ # autoflush without IO::Handle
+ my $fh = select STDERR;
+ $| = 1;
+ select $fh;
}
-my $feeder = Feeder->new();
+my $feeder = App::MPD::Feeder->new();
if (@ARGV) {
- my $cmd = shift @ARGV;
-
- if ($cmd eq 'dump-config') {
- die "dump-config command accepts no arguments\n" if @ARGV;
-
- $feeder->opt->dump;
- exit;
- }
-
- if ( $cmd eq 'add-unwanted-artist' ) {
- die "Missing command arguments\n" unless @ARGV;
- $feeder->set_db_needs_update(0);
- for my $artist (@ARGV) {
- if ( $feeder->db_add_unwanted_artist($artist) ) {
- $log->info("Artist '$artist' added to the unwanted list\n");
- }
- else {
- $log->warn("Artist '$artist' already in the unwanted list\n");
- }
- }
- exit;
- }
-
- if ( $cmd eq 'del-unwanted-artist' ) {
- die "Missing command arguments\n" unless @ARGV;
- $feeder->set_db_needs_update(0);
- for my $artist (@ARGV) {
- if ( $feeder->db_del_unwanted_artist($artist) ) {
- $log->info("Artist '$artist' deleted from the unwanted list\n");
- }
- else {
- $log->warn("Artist '$artist' is not in the unwanted list\n");
- }
- }
- exit;
- }
-
- if ( $cmd eq 'add-unwanted-album' ) {
- die "NOT IMPLEMENTED\n";
- }
-
- if ( $cmd eq 'one-shot' ) {
- die "one-shot command accepts no arguments\n" if @ARGV;
-
- $feeder->queue_songs(undef, sub { exit });
- $feeder->mpd->loop->run;
- }
- elsif ( $cmd eq 'single' ) {
- die "single command accepts no arguments\n" if @ARGV;
-
- $feeder->queue_songs(1, sub { exit });
- $feeder->mpd->loop->run;
- }
- else {
- die "Unknown command '$cmd'";
- }
+ require App::MPD::Feeder::Command;
+ bless $feeder, 'App::MPD::Feeder::Command';
+
+ exit $feeder->run(@ARGV);
}
-$feeder->connect_db;
+$feeder->run_loop;
-for ( ;; ) {
- $feeder->queue_songs( undef, sub { $feeder->run } );
+__END__
- $log->debug("Entering event loop. PID=$$");
+=encoding UTF-8
- my $result = $feeder->mpd->loop->run;
- $log->trace( "Got loop result of " . ( $result // 'undef' ) );
+=head1 NAME
- if ('reload' eq $result) {
- $log->notice("disconnecting");
- $feeder->stop;
+mpd-feeder -- MPD playlist manager with emphasys on diversity
- exec( "$0", '--config', $feeder->cfg_file, '--skip-db-update' );
- }
-}
+=head1 SYNOPSIS
+
+Engage daemon mode, keeping the MPD playlist full:
+
+ mpd-feeder [I<option>...]
+
+Perform a single command and return to the OS:
+
+ mpd-feeder [I<option>...] I<command>
+
+=head1 DESCRIPTION
+
+C<mpd-feeder> keeps the playlist of MPD full with songs, avoiding songs,
+artists and albums that have been queued recently. This can be used for
+listening to large song collections without repetitions that happen with random
+shuffling or when a given artist has many more songs that the rest.
+
+The song list is stored in a PostgreSQL database that is kept updated
+automatically as the MPD database is updated.
+
+The timespans for "recent" queueing are configurable.
+
+=head1 COMMANDS
+
+In daemon mode (with no command given), C<mpd-feeder> connects to MPD, updates
+its local copy of the song database (but see C<--skip-db-update> option below)
+and makes sure that the playlist is never left with fewer songs than the
+configured minimum. Playlist changes are detected when they happen.
+
+When a command is given, C<mpd-feeder> does not engage in daemon mode, but
+returns to the OS after execution.
+
+=head2 dump-config
+
+Prints configuration file contents on standard output. Can be used to create
+skeleton F<mpd-feeder.conf>. Makes no connection to MPD or PostgreSQL.
+
+=head2 add-unwanted-artist I<artist name>
+
+Adds one artist to toe list of unwanted artists. That list is consulted when a
+new song needs to be added to MPD's playlist and songs by artists in it are
+skipped.
+
+=head2 del-unwanted-artist I<artist name>
+
+The reverse of C<add-unwanted-artist>.
+
+=head2 list-unwanted-artists
+
+Prints the contents of the unwanted artist list, one per line.
+
+=head2 add-unwanted-album I<album name> by I<artist name>
+
+=head2 del-unwanted-album I<album name> by I<artist name>
+
+=head2 list-unwanted-albums
+
+Manupulate the list of unwanted albums. Useful when there is a specific album
+you don't want to listen to, but you don't mind other albums by the same
+artist.
+
+=head2 one-shot
+
+Connects to MPD, and if the playlist is below the configured minimum, adds some
+songs.
+
+=head2 single
+
+Adds one song to the playlist. Ignores the configured minimum playlist length.
+
+=head1 OPTIONS
+
+=over
+
+=item B<--config> I<file>
+
+=item B<--cfg> I<file>
+
+The configuration file to read at startup.
+
+B<Default>: C</etc/mpd-feeder/mpd-feeder.conf>.
+
+=item B<--log-level> I<trace|debug|info|notice|warning|error|critical|alert|emergency>
+
+Set log verbosity. C<trace> is most talkative, including all exchanges with MPD.
+
+=item B<--skip-db-update>
+
+Skips the startup sync of the song database from MPD.
+
+=item B<--tql> I<number>
+
+=item B<--target-queue-length> I<number>
+
+Sets the wanted playlist length.
+
+=item B<--mpd-host> I<hostname>
+
+=item B<--mpd-port> I<number>
+
+Parameters for connecting to MPD.
+
+=item B<--db-path> I<DSN>
+
+=item B<--db-user> I<username>
+
+Parameters for connecting to PostgreSQL.
+
+=item B<--min-album-interval> I<duration>
+
+=item B<--min-song-interval> I<duration>
+
+=item B<--min-artist-interval> I<duration>
+
+Tunes the minimum time between adding songs from the same album/artist and
+before re-adding the same song.
+
+I<duration> is a text duration, recognised by L<Time::Duration::Parse>.
+
+=back
+
+=head1 CONFIGURATION FILE
+
+Configuration file is an C<.ini> file with the following sections. You can get
+a skeleton configuration by executing C<mpd-feeder dump-config>. That will
+produce a configuration file filled with the default values.
+
+=head2 [mpd-feeder]
+
+=over
+
+=item B<log_level> = I<level>
+
+Determines the verboseness of the logging. See L</--log-level> option above.
+
+B<Default>: C<warn>.
+
+=back
+
+=head2 [mpd]
+
+=over
+
+=item B<host> = I<hostname>
+
+The host where MPD is running.
+
+B<Default>: none. However, L<Net::Async::MPD> defaults to the value of the
+C<MPD_HOST> environment variable, and if that is empty - C<localhost>.
+
+=item B<port> = I<number>
+
+The port number where MPD is listening.
+
+B<Default>: none. However, L<Net::Async::MPD> defaults to the value of the
+C<MPD_PORT> environment variable, and if that is empty - C<6600>.
+
+=item B<initial-reconnect-delay> = I<duration>
+
+=item B<max-reconnect-delay> = I<duration>
+
+When the connection to MPD is lost, a delay is inserted before a re-connection
+attempt is made. The duration of the delay is controlled with these two
+options. Each delay is a bit longer than the last, starting with the value of
+<initial-reconnect-delay>, and topped at the value of C<max-reconnect-delay>.
+
+When a connection is made, the delay before the next re-connection is reset to
+C<initial-reconnect-delay>.
+
+B<Default>: C<3 seconds> for C<initial-reconnect-delay> and C<2 minutes> for
+C<max-reconnect-delay>.
+
+=back
+
+=head2 [queue]
+
+=over
+
+=item B<target-length> = I<number>
+
+The number of songs to always have in the MPD's playlist.
+
+B<Default>: C<10>.
+
+=item B<min-song-interval> = I<duration>
+
+The minimum amount of time after a song is added to the playlist by
+B<mpd-feeder>, before it is considered again.
+
+B<Default>: C<13 days>
+
+=item B<min-album-interval> = I<duration>
+
+The minimum amount of time after a song is added to the playlist by
+B<mpd-feeder> before songs from the same album are considered for addition to
+the playlist.
+
+B<Default>: C<5 hours>.
+
+=item B<min-artist-interval> = I<duration>
+
+The minimum amount of time after a song is added to the playlist by
+B<mpd-feeder> before songs by the same artist are consideret for addition to
+the playlist.
+
+B<Default>: C<1 hour and 15 minutes>.
+
+=back
+
+=head2 [db]
+
+=over
+
+=item B<path> = I<DSN>
+
+PostgresQL database name to use for local storage.
+
+B<Default>: C<mpd-feeder>
+
+=item B<user> = I<name>
+
+PostgreSQL user name to connect as.
+
+B<Default>: none.
+
+=item B<password> = I<secret>
+
+Password to use when connecting to PostgreSQL.
+
+B<Default>: none.
+
+=back
+
+See F<init.sql> file in the distribution for commands to initializa the
+database.
+
+=head1 COPYRIGHT & LICENSE
+
+Copyright © 2021 Damyan Ivanov L<dam+mpdfeeder@ktnx.net>
+
+This program is free software: you can redistribute it and/or modify it under
+the terms of the GNU General Public License version 3 as published by the Free
+Software Foundation.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+this program. If not, see <http://www.gnu.org/licenses/>.
projects / mpd-feeder.git / blobdiff