source: server/lib/gutenbach @ c5a98db

debianmacno-cupsweb
Last change on this file since c5a98db was c5a98db, checked in by Jessica B. Hamrick <jhamrick@…>, 14 years ago
  • Fixed support for playing YouTube? videos
  • Fixed error with CUPS_SERVER in gbr and gbrm
  • Added support for playing YouTube? URLs with gbr
  • Property mode set to 100755
File size: 10.6 KB
Line 
1#!/usr/bin/perl
2# Play the data on STDIN as an audio file
3#
4# $Id: gutenbach-filter,v 1.26 2009/02/20 00:27:17 geofft Exp root $
5# $Source: /usr/local/bin/RCS/gutenbach-filter,v $
6#
7# TODO
8# ----
9# Make this structured code. It's a mess.
10# Repeat what we just played for EXT files too
11# Support HTTP Auth on ogg streams
12# License, cleanup and package
13#
14# Jered Floyd <jered@mit.edu> takes very little credit for this code
15# apparently neither does Quentin Smith <quentin@mit.edu>
16
17use strict;
18use warnings;
19use Image::ExifTool qw(ImageInfo);
20use File::Spec::Functions;
21use File::Temp qw{tempfile tempdir};
22use File::Basename qw(basename);
23use LWP::UserAgent;
24use Data::Dumper;
25use IPC::Open2;
26use English;
27
28use vars qw/$zephyr_class $host $queue $mixer $channel/;
29
30require "/usr/lib/gutenbach/config/gutenbach-filter-config.pl" or die "Unable to load configuration";
31
32my $ua = new LWP::UserAgent;
33
34# This variable contains the pid of the child process (which runs
35# mplayer) once it has been forked, so that we can kill it on SIGTERM
36my $pid;
37
38# Replace STDERR with a log file in /tmp.
39open(CUPS, ">&STDERR") or die "Unable to copy CUPS filehandle";
40close(STDERR);
41open(STDERR, ">>", "/tmp/gutenbach.log") or warn "Couldn't open log: $!";
42
43# Set the TERM environment (for the benefit of mplayer?)
44# I don't know why we do this --quentin
45$ENV{"TERM"}="vt100";
46
47print STDERR "STDERR FROM SPOOL FILTER\n";
48
49# CUPS provides us with these arguments:
50#
51# argv[1]
52# The job ID
53# argv[2]
54# The user printing the job
55# argv[3]
56# The job name/title
57# argv[4]
58# The number of copies to print
59# argv[5]
60# The options that were provided when the job was submitted
61# argv[6]
62# The file to print (first program only)
63#
64# The scheduler runs one or more of these programs to print any given
65# job. The first filter reads from the print file and writes to the
66# standard output, while the remaining filters read from the standard
67# input and write to the standard output. The backend is the last
68# filter in the chain and writes to the device.
69
70printf(STDERR "Got \@ARGV: %s\n", Dumper(\@ARGV));
71
72my %arguments = (
73                 "job-id" => $ARGV[0],
74                 user => $ARGV[1],
75                 "job-title" => $ARGV[2],
76                 copies => $ARGV[3],
77                 options => {split(/[= ]/, $ARGV[4])},
78                 file => $ARGV[5],
79                );
80
81# If we weren't given a filename, we need to read from stdin. Since
82# mplayer really wants a file, let's write out to a temporary file
83# first.
84if (!$arguments{"file"}) {
85  my ($fh, $file) = tempfile("gutenbachXXXXX", UNLINK => 1); # Ask File::Temp for a safe temporary file
86  my $buf;
87  while (read(STDIN, $buf, 1024*1024)) { # Read 1M at a time and put it in the temporary file
88    print $fh $buf;
89  }
90  close($fh);
91  $arguments{"file"} = $file;
92}
93
94printf(STDERR "Got \%arguments: %s\n", Dumper(\%arguments));
95
96# Open up a zwrite command to announce the current track.
97my @zwrite_command = (qw(/usr/bin/zwrite -d -n -c), $zephyr_class, "-i", $queue.'@'.$host, "-s", "Gutenbach Music Spooler");
98
99print STDERR "Invoking @zwrite_command\n";
100open(ZEPHYR, "|-", @zwrite_command) or die "Couldn't launch zwrite: $!";
101
102my $status;
103if (exists($arguments{"options"}{"job-originating-host-name"})) {
104    print(ZEPHYR $arguments{"user"},"\@",$arguments{"options"}{"job-originating-host-name"}," is playing:\n");
105    $status = "User: ".$arguments{"user"}."\@".$arguments{"options"}{"job-originating-host-name"};
106} else {
107    print(ZEPHYR $arguments{"user"}," is playing:\n");
108    $status = "User: ".$arguments{"user"};
109}
110
111# SIGHUP handler, in case we were aborted
112sub clear_status {
113  kill 15, $pid if $pid;
114  my @zwrite_command = (qw(/usr/bin/zwrite -d -n -c), $zephyr_class, "-i", $queue.'@'.$host, "-s", "Gutenbach Music Spooler");
115  open(ZEPH, "|-", @zwrite_command);
116  print(ZEPH "Playback aborted.\n");
117  close(ZEPH);
118  die;
119}
120
121$SIG{HUP} = \&clear_status;
122$SIG{TERM} = \&clear_status;
123
124# Read the metadata information from the file.
125my ($filepath) = $arguments{"file"};
126my ($fileinfo) = ImageInfo($filepath);
127my ($magic) = $fileinfo->{FileType};
128my ($tempdir);
129my ($newpath);
130
131if ($magic) {
132  # $magic means that Image::ExifTool was able to identify the type of file
133  printf(ZEPHYR "%s file %s\n", $magic, $arguments{"job-title"});
134  $status .= sprintf(" Filetype: %s.", $magic);
135  $status .= sprintf(" Filename: %s.", $arguments{"job-title"});
136
137  if (exists $fileinfo->{'Title'}) {
138    printf(ZEPHYR "\@b{%s}\n", $fileinfo->{'Title'}) if exists $fileinfo->{'Title'};
139    $status .= sprintf(" Title: %s.", $fileinfo->{'Title'});
140  }
141  foreach my $key (qw/Artist Album AlbumArtist/) {
142    if (exists $fileinfo->{$key}) {
143      printf(ZEPHYR "%s\n", $fileinfo->{$key}) if exists $fileinfo->{$key};
144      $status .= sprintf(" %s: %s\n", $key, $fileinfo->{$key});
145    }
146  }
147
148  $tempdir = tempdir();
149  #awful hack -- geofft
150  #== -- quentin
151  # This code appears to create a new temporary directory and symlink
152  # the job file into the temporary directory under the original
153  # filename. I think this is because mplayer sometimes uses the file
154  # extension to identify a filetype.
155  $newpath = $tempdir . '/' . basename($arguments{"job-title"});
156  symlink($filepath, $newpath);
157  $filepath = $newpath;
158}
159elsif ($arguments{copies} == 42) {
160  # This is a flag that is set by jobs queued by split_playlist(); it tells us to not try to split the playlist again.
161  # Call resolve_external_reference to apply some heuristics to determine the filetype.
162  $filepath = resolve_external_reference($filepath, \%arguments);
163  if ($filepath =~ m|http://www\.youtube\.com/watch\?v=|) {
164    # YouTube URLs are resolved by the youtube-dl command.
165    # Launch youtube-dl
166    $pid = open(YTDL, "-|");
167    if ($pid) {
168        print ZEPHYR "YouTube video $filepath.\nCurrently downloading, please wait...";
169        close ZEPHYR;
170        while (<YTDL>) {
171            open(ZEPHYR, "|-", @zwrite_command);
172            print ZEPHYR $_;
173            close ZEPHYR;
174        }
175        open(ZEPHYR, "|-", @zwrite_command);
176        print ZEPHYR "Done downloading.";
177        close ZEPHYR;
178    }
179    else {
180        my @args = ("youtube-dl", "-q", "-o", "/tmp/youtube.flv", $filepath);
181        exec(@args) or die "Couldn't exec youtube-dl";
182    }
183
184    $filepath = "/tmp/youtube.flv";
185    # Print the title to zephyr and the status string.
186  } else { # Doesn't appear to be a YouTube URL.
187    print STDERR "Resolved external reference to $filepath\n";
188    printf(ZEPHYR "%s\n", $filepath);
189    $status .= sprintf(" External: %s\n", $filepath);
190  }
191}
192elsif (-T $filepath) { # If the file appears to be a text file, treat it as a playlist.
193  split_playlist($filepath, \%arguments);
194  close(ZEPHYR);
195  # See http://www.cups.org/documentation.php/api-filter.html#MESSAGES
196  print CUPS "NOTICE: $status\n";
197  exit 0;
198}
199
200close(ZEPHYR);
201print CUPS "NOTICE: $status\n";
202play_mplayer_audio($filepath, \%arguments);
203
204# Remove the symlink we made earlier for the filetype.
205if ($magic) {
206  unlink($newpath);
207  rmdir($tempdir);
208}
209
210# Play an external stream reference
211sub resolve_external_reference {
212  # Retrieve those command line opts.
213  my ($filepath, $arguments) = @_;
214
215  my ($format, $uri, $userpass);
216
217  open(FILE, "<", $filepath) or die "Couldn't open spool file";
218  if (<FILE> =~ /^(\S+)/) {
219    # Take the leading non-whitespace as a URL
220    $uri=$1;
221
222    if ($uri =~ m|http://www\.youtube\.com/watch\?v=|) {
223      return $uri;
224    }
225
226    # Fetch the URL with a HEAD request to get the content type
227    my $response = $ua->head($uri);
228
229    my $contenttype=($response->content_type() or "unknown");
230
231    if ($contenttype eq "audio/mpeg") { $format="MP3" }
232    elsif ($contenttype eq "application/x-ogg") { $format="OGG" }
233    elsif ($contenttype eq "application/ogg") { $format="OGG" }
234    elsif ($contenttype eq "audio/x-scpls") { $format="SHOUTCAST" }
235    else {
236      print ZEPHYR
237        "Unknown Content-Type $contenttype for URI $uri\n";
238    }
239  } else { # Unable to match the URL regex
240    print ZEPHYR "Couldn't read URI for external reference\n";
241    # Return the existing path, in the hopes that mplayer knows what to do with it.
242    return $filepath;
243  }
244
245  if ($format eq "SHOUTCAST") {
246    print ZEPHYR "Shoutcast playlist...\n";
247    return get_shoutcast($uri);
248  } elsif ($format eq "MP3") {
249  } elsif ($format eq "OGG") {
250  } else {
251    print ZEPHYR "Unrecognized stream format: $format\n";
252  }
253  return $uri;
254}
255
256sub split_playlist {
257  my ($file, $arguments) = @_;
258
259  my $i = 0;
260
261  open(FILE, "<", $filepath) or die "Couldn't open spool file";
262  while (<FILE>) {
263    chomp;
264    if (/^([^#]\S+)/) {
265      printf (STDERR "Found playlist line: %s\n", $_);
266      $ENV{CUPS_SERVER}='localhost';
267      open(LP, "|-", "lp", "-d", "$queue", "-n", "42"); #'-#', '42', '-J', $arguments->{"job-title"}, '-o', 'job-priority=100');
268      print LP $1;
269      close(LP);
270      $i++;
271    }
272  }
273  printf(ZEPHYR "Playlist containing %d valid entries, split into separate jobs.\n", $i);
274}
275
276# Process a Shoutcast playlist
277# get_shoutcast(URI)
278sub get_shoutcast {
279  my $uri = shift(@_);
280
281  my $response = $ua->get($uri);
282  my (@titles, @uris);
283
284  foreach (split("\n", $response->content())) {
285      if (/^File\d+=(\S+)/) {
286          push(@uris, $1);
287      }
288      if (/^Title\d+=(.+)$/) {
289          push(@titles, $1);
290      }
291  }
292
293  # choose a random server
294  my $server = int(rand scalar(@uris));
295  # print the name of the stream if available
296  print ZEPHYR "$titles[$server]\n";
297  return $uris[$server];
298}
299
300sub play_mplayer_audio {
301  my ($filepath, $opts) = @_;
302
303  # Open up a zwrite command to show the mplayer output
304  my @zwrite_command = (qw(/usr/bin/zwrite -d -n -c), $zephyr_class, "-i", $queue.'@'.$host, "-s", "Gutenbach Music Spooler");
305
306  print STDERR "Invoking (from play_mplayer_audio): @zwrite_command\n";
307
308  # fork for mplayer
309  $pid = open(MP3STATUS, "-|");
310  unless (defined $pid) {
311    open(ZEPHYR, "|-", @zwrite_command) or die "Couldn't launch zwrite: $!";
312    print ZEPHYR "Couldn't fork: $!\n";
313    close(ZEPHYR);
314    return;
315  }
316
317  if ($pid) { #parent
318    # Check if there were any errors
319    if ($_ = <MP3STATUS>) {
320      open(ZEPHYR, "|-", @zwrite_command) or die "Couldn't launch zwrite: $!";
321      print ZEPHYR "Playback completed with the following errors:\n";
322      while (<MP3STATUS>) {
323        print ZEPHYR $_;
324      }
325      close(ZEPHYR);
326    } else {
327      open(ZEPHYR, "|-", @zwrite_command) or die "Couldn't launch zwrite: $!";
328      print ZEPHYR "Playback completed successfully.\n";
329      close(ZEPHYR);
330    }
331    close(MP3STATUS) || print ZEPHYR "mplayer exited $?\n";
332  }
333  else { # child
334    # redirect STDERR to STDOUT
335    open STDERR, '>&STDOUT';
336    # make sure that mplayer doesn't try to intepret the file as keyboard input
337    close(STDIN);
338    open(STDIN, "/dev/null");
339
340    my @args = (qw|/usr/bin/mplayer -vo fbdev2 -zoom -x 1024 -y 768 -framedrop -nolirc -cache 512 -ao alsa -really-quiet |, $filepath);
341    #pint STDERR "About to exec: ", Dumper([@args]);
342    exec(@args) ||
343      die "Couldn't exec";
344  }
345}
Note: See TracBrowser for help on using the repository browser.