scripts/mpdmenu.pl

   1 #!/usr/bin/perl
   2
   3 use strict;
   4
   5 use Getopt::Long;
   6 use IO::Socket::INET6;
   7
   8 use constant {
   9         MPD_MJR_MIN => 0,
  10         MPD_MNR_MIN => 13,
  11         MPD_REV_MIN => 0,
  12 };
  13
  14 use utf8;
  15 use encoding 'utf8';
  16 use Encode;
  17
  18 sub cmd
  19 {
  20         print "$_[0]\n";
  21 }
  22
  23 # Global hash for tracking what is to be "accepted".
  24 my %accept = ();
  25
  26 my $FVWM = (defined $ENV{FVWM_USERDIR}) ? $ENV{FVWM_USERDIR}
  27                                         : $ENV{HOME}."/.fvwm";
  28 my $icons = "$FVWM/icons";
  29
  30 # Default values for stuff.
  31 my ($album, $artist, $title, $menu) = (undef, undef, undef, undef);
  32 my $host = (defined $ENV{MPD_HOST}) ? $ENV{MPD_HOST} : "localhost";
  33 my $port = (defined $ENV{MPD_PORT}) ? $ENV{MPD_PORT} : "6600";
  34
  35 GetOptions(
  36         'host|h=s'   => \&host,   # Host that MPD is running on.
  37         'port|p=s'   => \&port,   # Port that MPD is listening on.
  38         'menu|m=s'   => \$menu,   # Name of the menu to create.
  39         'album=s'    => \$album,  # Album to get tracks from
  40         'artist=s'   => \$artist, # Artist to limit results to
  41         'title=s'    => \$title,  # Title to create menu for
  42 );
  43
  44 $album  = decode_utf8($album)  if defined($album);
  45 $artist = decode_utf8($artist) if defined($artist);
  46 $title  = decode_utf8($title)  if defined($title);;
  47
  48 # Connect to MPD.
  49 my $sock = new IO::Socket::INET6(
  50         PeerAddr => $host,
  51         PeerPort => $port,
  52         Proto => 'tcp'
  53 ) or die("could not open socket: $!.\n");
  54 binmode($sock, ":utf8");
  55
  56 die("could not connect to MPD: $!.\n")
  57         if (!(<$sock> =~ /^OK MPD ([0-9]+)\.([0-9]+)\.([0-9]+)$/));
  58
  59 die("MPD version $1.$2.$3 insufficient.\n")
  60         if (  ($1 <  MPD_MJR_MIN)
  61            || ($1 == MPD_MJR_MIN && $2 <  MPD_MNR_MIN)
  62            || ($1 == MPD_MJR_MIN && $2 == MPD_MNR_MIN && $3 < MPD_REV_MIN));
  63
  64 if (defined $album) {
  65         # Create an album menu.
  66         my @playlist = ();
  67         my $entry;
  68
  69         $menu = "MenuMPDAlbum" unless defined $menu;
  70
  71         $album =~ s/"/\\"/g;
  72         print $sock "playlistfind album \"$album\"\n";
  73         while (<$sock>) {
  74                 last if (/^OK/);
  75                 die($_) if (/^ACK/);
  76
  77                 if (/^(\w+): (.*)$/) {
  78                         if ($1 eq "file") {
  79                                 if (keys(%$entry) > 0) {
  80                                         addalbumentry(\@playlist, $entry)
  81                                 }
  82
  83                                 $entry = {};
  84                         }
  85
  86                         $entry->{$1} = $2;
  87                 }
  88         }
  89         addalbumentry(\@playlist, $entry) if (keys(%$entry) > 0);
  90
  91         die("No tracks found.\n") if (!@playlist);
  92         foreach (sort albumsort @playlist) {
  93                 my ($t_file, $t_trackno, $t_artist, $t_title, $t_id) = (
  94                         $_->{file},
  95                         $_->{Track},
  96                         $_->{Artist},
  97                         $_->{Title},
  98                         $_->{Id},
  99                 );
 100
 101                 next if (defined $artist && !$accept{albumdir($t_file)});
 102
 103                 $t_artist = sanitise($t_artist);
 104                 $t_title  = sanitise($t_title);
 105
 106                 my $cmd = sprintf "AddToMenu $menu \"%d\t%s - %s\""
 107                                   ." Exec mpc playid %d",
 108                                   $t_trackno, $t_artist, $t_title, $t_id;
 109
 110                 cmd($cmd);
 111         }
 112 } elsif (defined $artist) {
 113         # Create an artist menu.
 114         my %albums = ();
 115         my $file;
 116         my $quoteartist = $artist;
 117
 118         $menu = "MenuMPDArtist" unless defined $menu;
 119
 120         $quoteartist =~ s/"/\\"/g;
 121         print $sock "playlistfind artist \"$quoteartist\"\n";
 122         while (<$sock>) {
 123                 last if (/^OK/);
 124                 die($_) if (/^ACK/);
 125
 126                 if (/^(\w+): (.*)$/) {
 127                         $file       = $2    if ($1 eq "file");
 128                         $albums{$2} = $file if ($1 eq "Album");
 129                 }
 130         }
 131
 132         die("No albums found.\n") if (!keys(%albums));
 133
 134 { # work around 'use locale' breaking s///i
 135         my $i = 0;
 136         use locale;
 137         foreach (sort keys(%albums)) {
 138                 my $key      = $_;
 139                 my $a_album  = sanitise($key);
 140
 141                 open THUMB, "-|", "$FVWM/scripts/thumbnail.zsh",
 142                                          "--small", "--music", $albums{$key};
 143                 my $thumb = <THUMB>;
 144                 close THUMB;
 145                 die("Incompetent use of thumbnail.zsh") if ($?);
 146
 147                 $thumb =~ s/\n//sg;
 148                 $thumb = "%$thumb%" if (-f $thumb);
 149
 150                 cmd("AddToMenu $menu \"$thumb$a_album\" Popup MenuMPDArt_$i");
 151
 152                 cmd("AddToMenu MenuMPDArt_$i DynamicPopUpAction MakeMenuMPDArt_$i");
 153
 154                 cmd("DestroyFunc MakeMenuMPDArt_$i");
 155                 cmd("AddToFunc   MakeMenuMPDArt_$i
 156                      + I DestroyMenu MenuMPDArt_$i
 157                      + I -PipeRead \"exec $FVWM/scripts/mpdmenu.pl "
 158                            ."--menu MenuMPDArt_$i "
 159                            ."--album  ".shellify($key, 1)." "
 160                            ."--artist ".shellify($artist, 1)."\"");
 161
 162                 cmd("AddToFunc KillMenuMPD I DestroyMenu MenuMPDArt_$i");
 163                 cmd("AddToFunc KillMenuMPD I DestroyFunc MakeMenuMPDArt_$i");
 164
 165                 $i++;
 166         }
 167 } # end use locale workaround
 168 } elsif (defined $title) {
 169         # Create a title menu.
 170         my @titles;
 171         my $entry;
 172
 173         $menu = "MenuMPDTitle" unless defined $menu;
 174
 175         # Open and close brackets.
 176         my ($ob, $cb) = ("[\[~〜<(ー−-]", "[\]~〜>)ー−-]");
 177
 178         $_ = $title;
 179
 180         # Deal with specific cases.
 181         s/ちいさな(?=ヘミソフィア)//;                 # ヘミソフィア
 182         s/ "mix on air flavor" dear EIKO SHIMAMIYA//; # Spiral wind
 183         s/ "So,you need me" Style//;                  # I need you
 184         s/ ::Symphony Second movement:://;            # Disintegration
 185         s/-\[instrumental\]//;                        # 青い果実
 186         s/ -Practice Track-//;                        # Fair Heaven
 187         s/〜世界で一番アナタが好き〜//;               # Pure Heart
 188         s/〜彼方への哀歌//;                           # 十二幻夢
 189         s/　sora no uta ver.//;                       # 美しい星
 190
 191         s/\s*-remix-$//; # Otherwise "D-THREAD -remix-" doesn't work right.
 192
 193         # Deal with titles like "blah (ABC version)".
 194         s/\s*$ob.*(style|mix|edit|edition|ver\.?|version|カラオケ)$cb?$//i;
 195
 196         # Deal with titles like "blah (without XYZ)".
 197         s/\s*$ob\s*((e\.)?piano|english|japanese|inst|tv|without|w\/o|off|back|short|karaoke|game).*//i;
 198
 199         # Deal with titles like "blah instrumental".
 200         s/\s+(instrumental|off vocal|short|tv)([\s-]+(size|version|s))?$//i;
 201         s/\s+without\s+\w+$//i;
 202
 203         my $basetitle  = $_;
 204         my $_basetitle = $basetitle;
 205
 206         $_basetitle =~ s/"/\\"/g;
 207         print $sock "playlistsearch title \"$_basetitle\"\n";
 208         while (<$sock>) {
 209                 last if (/^OK/);
 210                 die($_) if (/^ACK/);
 211
 212                 if (/^(\w+): (.*)$/) {
 213                         if ($1 eq "file") {
 214                                 push @titles, $entry if (keys(%$entry) > 0);
 215                                 $entry = {};
 216                         }
 217
 218                         $entry->{$1} = $2;
 219                 }
 220         }
 221         push @titles, $entry if (keys(%$entry) > 0);
 222
 223 { # work around 'use locale' breaking s///i
 224         use locale;
 225         foreach (sort titlesort @titles) {
 226                 my ($t_file, $t_artist, $t_title, $t_id) = (
 227                         $_->{file},
 228                         $_->{Artist},
 229                         $_->{Title},
 230                         $_->{Id},
 231                 );
 232
 233                 # MPD searches are case-insensitive.
 234                 next if (!($t_title =~ m/(\P{Latin}|^)\Q$basetitle\E(\P{Latin}|$)/));
 235                 $t_artist = sanitise($t_artist);
 236                 $t_title  = sanitise($t_title);
 237
 238                 open THUMB, "-|", "$FVWM/scripts/thumbnail.zsh",
 239                                          "--small", "--music", $t_file;
 240                 my $thumb = <THUMB>;
 241                 close(THUMB);
 242                 die("Incompetent use of thumbnail.zsh") if ($?);
 243
 244                 $thumb =~ s/\n//sg;
 245                 $thumb = "%$thumb%" if (-f $thumb);
 246
 247                 cmd("AddToMenu $menu \"$thumb$t_artist - $t_title\" Exec mpc playid $t_id");
 248         }
 249 } # end use locale workaround
 250 } else {
 251         # Make MPD base menu
 252         my ($state, $songid) = (undef, undef);
 253         my %entry = ();
 254
 255         $menu = "MenuMPD" unless defined $menu;
 256
 257         print $sock "status\n";
 258         while (<$sock>) {
 259                 last if (/^OK/);
 260                 die($_) if (/^ACK/);
 261
 262                 if (/^(\w+): (.*)$/) {
 263                         $state  = $2 if ($1 eq "state");
 264                         $songid = $2 if ($1 eq "songid");
 265                 }
 266         }
 267         die("Failed status query\n") unless (defined $state);
 268
 269         cmd("AddToMenu $menu Playing Title") if ($state eq "play");
 270         cmd("AddToMenu $menu Paused Title")  if ($state eq "pause");
 271         cmd("AddToMenu $menu Stopped Title") if ($state eq "stop");
 272
 273         if (defined $songid) {
 274                 print $sock "playlistid $songid\n";
 275                 while (<$sock>) {
 276                         last if (/^OK/);
 277                         die($_) if (/^ACK/);
 278
 279                         if (/^(\w+): (.*)$/) {
 280                                 $entry{$1} = $2;
 281                         }
 282                 }
 283                 die("Failed data query\n") unless (keys(%entry) > 0);
 284
 285                 open THUMB, "-|", "$FVWM/scripts/thumbnail.zsh",
 286                                          "--image", "--music",  $entry{file};
 287                 my $thumb = <THUMB>;
 288                 my $scan  = <THUMB>;
 289                 close(THUMB);
 290                 die("Incompetent use of thumbnail.sh") if ($?);
 291
 292                 $thumb =~ s/\n//sg;
 293                 $scan  =~ s/\n//sg;
 294
 295                 if (-f $thumb) {
 296                         cmd("AddToMenu $menu \"*$thumb*\" "
 297                                 ."Exec exec gqview ".shellify($scan, 0));
 298                 }
 299                 cmd("AddToMenu $menu \"Title:   ".sanitise($entry{Title})."\" "
 300                         ."Popup MenuMPDTitle");
 301                 cmd("AddToMenu $menu \"Artist:  ".sanitise($entry{Artist})."\" "
 302                         ."Popup MenuMPDArtist");
 303                 cmd("AddToMenu $menu \"Album:   ".sanitise($entry{Album})."\" "
 304                         ."Popup MenuMPDAlbum");
 305                 cmd("AddToMenu $menu \"\" Nop");
 306         } else {
 307                 cmd("AddToMenu $menu \"<Song info unavailable>\"");
 308                 cmd("AddToMenu $menu \"\" Nop");
 309         }
 310
 311         if ($state eq "play" || $state eq "pause") {
 312                 cmd("AddToMenu $menu \"\t\tNext%$icons/next.svg:16x16%\" "
 313                         ."Exec exec mpc next");
 314                 cmd("AddToMenu $menu \"\t\tPause%$icons/pause.svg:16x16%\" "
 315                         ."Exec exec mpc pause") if ($state eq "play");
 316                 cmd("AddToMenu $menu \"\t\tPlay%$icons/play.svg:16x16%\" "
 317                         ."Exec exec mpc play") if ($state eq "pause");
 318                 cmd("AddToMenu $menu \"\t\tStop%$icons/stop.svg:16x16%\" "
 319                         ."Exec exec mpc stop");
 320                 cmd("AddToMenu $menu \"\t\tPrev%$icons/prev.svg:16x16%\" "
 321                         ."Exec exec mpc prev");
 322         } elsif ($state eq "stop") {
 323                 cmd("AddToMenu $menu \"\t\tPlay%$icons/play.svg:16x16%\" "
 324                         ."Exec exec mpc play");
 325         } else {
 326                 die("Unknown MPD state!\n");
 327         }
 328
 329         cmd("AddToMenu $menu \"\" Nop");
 330         cmd("AddToMenu $menu \"\t\tShuffle%$icons/shuffle.svg:16x16%\" "
 331                 ."Exec exec mpc shuffle");
 332
 333         cmd("DestroyMenu MenuMPDTitle");
 334         cmd("AddToMenu   MenuMPDTitle  DynamicPopUpAction MakeMenuMPDTitle");
 335         cmd("DestroyMenu MenuMPDArtist");
 336         cmd("AddToMenu   MenuMPDArtist DynamicPopUpAction MakeMenuMPDArtist");
 337         cmd("DestroyMenu MenuMPDAlbum");
 338         cmd("AddToMenu   MenuMPDAlbum  DynamicPopUpAction MakeMenuMPDAlbum");
 339
 340         cmd("DestroyFunc MakeMenuMPDTitle");
 341         cmd("AddToFunc   MakeMenuMPDTitle
 342              + I DestroyMenu MenuMPDTitle
 343              + I -PipeRead \"exec $FVWM/scripts/mpdmenu.pl "
 344                            ."--menu MenuMPDTitle "
 345                            ."--title ".shellify($entry{Title}, 1)."\"");
 346
 347         cmd("DestroyFunc MakeMenuMPDAlbum");
 348         cmd("AddToFunc   MakeMenuMPDAlbum
 349              + I DestroyMenu MenuMPDAlbum
 350              + I -PipeRead \"exec $FVWM/scripts/mpdmenu.pl "
 351                            ."--menu MenuMPDAlbum "
 352                            ."--album  ".shellify($entry{Album}, 1)." "
 353                            ."--artist ".shellify($entry{Artist}, 1)."\"");
 354
 355         cmd("DestroyFunc MakeMenuMPDArtist");
 356         cmd("AddToFunc   MakeMenuMPDArtist
 357              + I DestroyMenu MenuMPDArtist
 358              + I -PipeRead \"exec $FVWM/scripts/mpdmenu.pl "
 359                            ."--menu MenuMPDArtist "
 360                            ."--artist ".shellify($entry{Artist}, 1)."\"");
 361
 362         cmd("DestroyFunc KillMenuMPD");
 363         cmd("AddToFunc   KillMenuMPD I Nop");
 364 }
 365
 366 # Finished.
 367 print $sock "close\n";
 368
 369 sub sanitise
 370 {
 371         $_ = $_[0];
 372         s/([\$&@%^*])/\1\1/g;
 373         s/"/\\"/g;
 374         return $_;
 375 }
 376
 377 sub addalbumentry
 378 {
 379         my ($playlist, $entry) = @_;
 380
 381         push(@$playlist, $entry);
 382
 383         if (defined $artist && $artist eq $entry->{Artist}) {
 384                 my $albumdir = albumdir($entry->{file});
 385                 $accept{$albumdir} = 1;
 386         }
 387 }
 388
 389 sub albumdir
 390 {
 391         my $file = $_[0];
 392
 393         $file =~ s:(/Disk [0-9]+[^/]*)?/[^/]*$::;
 394         return $file
 395 }
 396
 397 sub albumsort
 398 {
 399         return ($a->{Disc} <=> $b->{Disc}) if ($a->{Disc} != $b->{Disc});
 400         return ($a->{Track} <=> $b->{Track});
 401 }
 402
 403 sub titlesort
 404 {
 405         return ($a->{Album}  cmp $b->{Album})  if($a->{Album}  ne $b->{Album});
 406         return ($a->{Artist} cmp $b->{Artist}) if($a->{Artist} ne $b->{Artist});
 407         return ($a->{Title}  cmp $b->{Title});
 408 }
 409
 410 sub shellify
 411 {
 412         my ($str, $quoted) = @_;
 413         $str =~ s/'/'\\''/g;
 414         if ($quoted) {
 415                 $str =~ s/\\/\\\\/g;
 416                 $str =~ s/"/\\"/g;
 417         }
 418         return "'$str'";
 419 }