run-mailcap 16.7 KB
Newer Older
1
#! /usr/bin/perl
2 3 4 5 6
###############################################################################
#
#  Run-Mailcap:  Run a program specified in the mailcap file based on a mime
#  type.
#
7
#  Written by Brian White <bcwhite@pobox.com>
8 9
#  This file has been placed in the public domain (the only true "free").
#
10
###############################################################################
11 12


13
$debug=($ENV{RUN_MAILCAP_DEBUG} || 0);
14
$norun=0;
15
$nopager=0;
16
$etcmimetyp="/etc/mime.types";
17 18
$shrmimetyp="/usr/share/etc/mime.types";
$locmimetyp="/usr/local/etc/mime.types";
19
$usrmimetyp="$ENV{HOME}/.mime.types";
20
$xtermprgrm="/usr/bin/x-terminal-emulator"; # xterm?
21
$defmimetyp="application/octet-stream";
22 23
$quotedsemi=chr(255);
$quotedprct=chr(254);
24
$retcode=0;
25 26


27 28
%patterntypes =
(
29 30 31
 '(^|/)crontab[^/]+$'                           => 'text/x-crontab',            #'
 '/man\d*/'                                     => 'application/x-troff-man',   #'
 '\.\d[^\.]*$'                                  => 'application/x-troff-man',   #'
32 33 34 35
);



36
sub Usage {
37 38 39 40 41 42 43
    my($error) = @_;
    print STDERR $error,"\n\n" if $error;

    print STDERR "Use: $0 <--action=VAL> [--debug] [MIME-TYPE:[ENCODING:]]FILE [...]\n\n";
    print STDERR "Options:\n";
    print STDERR "  action        specify what action to do on these files (default=view)\n";
    print STDERR "  debug         be verbose about what's going on\n";
44
    print STDERR "  nopager       ignore any \"copiousoutput\" directives and never use a \"pager\"\n";
45
    print STDERR "  norun         just print but don't execute the command (useful with --debug)\n";
46 47 48 49 50 51 52 53 54 55
    print STDERR "\n";
    print STDERR "Mime-Type:\n";
    print STDERR "  any standard mime type designation in the form <class>/<subtype> -- if\n";
    print STDERR "  not specified, it will be determined from the filename extension\n\n";
    print STDERR "Encoding:\n";
    print STDERR "  how the file (and type) has been encoded (only \"gzip\", \"bzip\", \"bzip2\"\n";
    print STDERR "  and \"compress\" are supported) -- if not specified, it will be determined\n";
    print STDERR "  from the filename extension\n\n";

    exit ($error ? 1 : 0);
56 57 58 59
}



60
sub EncodingForFile {
61 62
    my($file) = @_;
    my $encoding;
63

64 65 66 67
    if ($file =~ m/\.gz$/)  { $encoding = "gzip";       }
    if ($file =~ m/\.bz$/)  { $encoding = "bzip";       }
    if ($file =~ m/\.bz2$/) { $encoding = "bzip2";      }
    if ($file =~ m/\.Z$/)   { $encoding = "compress";   }
68

69
    print STDERR " - file \"$file\" has encoding \"$encoding\"\n" if $debug && $encoding;
70

71
    return $encoding;
72 73 74 75 76
}



sub ReadMimetypes {
77
    my($file) = @_;
78

79
    return unless -r $file;
80

81 82 83 84 85 86
    print STDERR " - Reading mime.types file \"$file\"...\n" if $debug;
    open(MIMETYPES,"<$file") || die "Error: could not read \"$file\" -- $!\n";
    while (<MIMETYPES>) {
        chomp;
        s/\#.*$//;
        next if (m/^\s*$/);
87

88 89
        $_=lc($_);
        my($type,@exts) = split;
90

91 92 93 94 95
        foreach (@exts) {
            $mimetypes{$_} = $type unless exists $mimetypes{$_};
        }
    }
    close MIMETYPES;
96 97 98 99 100
}



sub ReadMailcap {
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
    my($file) = @_;
    my $line = "";

    return unless -r $file;

    print STDERR " - Reading mailcap file \"$file\"...\n" if $debug;
    open(MAILCAP,"<$file") || die "Error: could not read \"$file\" -- $!\n";
    while (<MAILCAP>) {
        chomp;
        s/^\s+// if $line;
        $line .= $_;
        next unless $line;
        if ($line =~ m/^\s*\#/) {
            $line = "";
            next;
        }
        if ($line =~ m/\\$/) {
            $line =~ s/\\$//;
        } else {
            $line =~ s/\\;/$quotedsemi/go;
            $line =~ s/\\%/$quotedprct/go;
            push @mailcap,$line;
            $line = "";
        }
    }
    close MAILCAP;
127 128 129 130 131
}



sub TempFile {
132 133 134
    my($template) = @_;
    my($cmd,$head,$tail,$tmpfile);
    $template = "" unless (defined $template);
135

136
    ($head,$tail) = split(/%s/,$template,2);
137

138 139
#   $tmpfile = POSIX::tmpnam($name);
#   unlink($tmpfile);
140

141 142 143
    $cmd  = "tempfile --mode=600";
    $cmd .= " --prefix $head" if $head;
    $cmd .= " --suffix $tail" if $tail;
144

145 146
    $tmpfile = `$cmd`;
    chomp($tmpfile);
147

148 149 150 151
#   $tmpfile = $ENV{TMPDIR};
#   $tmpfile = "/tmp" unless $tmpfile;
#   $tmpfile.= "/$name";
#   unlink($tmpfile);
152

153
    return $tmpfile;
154 155 156 157 158
}



sub SaveStdin {
159 160 161 162 163 164 165 166 167 168 169 170 171
    my($match) = @_;
    my($tmpfile,$amt,$buf);

    $tmpfile = $1 if ($match =~ m/nametemplate=(.*?)\s*($|;)/);
    $tmpfile = TempFile($tmpfile);
    open(TMPFILE,">$tmpfile") || die "Error: could not write \"$tmpfile\" -- $!\n";
    do {
        $amt = read(STDIN,$buf,102400);
        print TMPFILE $buf if $amt;
    } while ($amt != 0);
    close(TMPFILE);

    return $tmpfile;
172 173 174
}


175

176
sub DecodeFile {
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    my($efile,$encoding,$action) = @_;
    my($file,$res);

    $file = $efile;
    $file =~ s!^.*/!!;          # remove leading directories
    $file =~ s!\.[^\.]*$!!;     # remove encoding extension
    $file =~ s!^\.?[^\.]*!%s!;  # replace name with placeholder
    $file = undef if ($efile eq '-');
    my $tmpfile = TempFile($file);

    print STDERR " - decoding \"$efile\" as \"$tmpfile\"\n" if $debug;

#   unlink($tmpfile); # should still be acceptable for "compose" output even if exists
    return $tmpfile if (($efile ne '-' && ! -e $efile) || $action eq 'compose');

    if ($encoding eq "gzip") {
        if ($efile eq '-') {
            $res = system "gzip -d >\Q$tmpfile\E";
        } else {
            $res = system "gzip -dc \Q$efile\E >\Q$tmpfile\E";
        }
    } elsif ($encoding eq "bzip") {
        if ($efile eq '-') {
            $res = system "bzip -d >\Q$tmpfile\E";
        } else {
            $res = system "bzip -dc <\Q$efile\E >\Q$tmpfile\E";
        }
    } elsif ($encoding eq "bzip2") {
        if ($efile eq '-') {
            $res = system "bzip2 -d >\Q$tmpfile\E";
        } else {
            $res = system "bzip2 -dc <\Q$efile\E >\Q$tmpfile\E";
        }
    } elsif ($encoding eq "compress") {
        if ($efile eq '-') {
            $res = system "uncompress >\Q$tmpfile\E";
        } else {
            $res = system "uncompress <\Q$efile\E >\Q$tmpfile\E";
        }
    } else {
        die "Fatal: unknown encoding \"$encoding\" at";
    }

    $res = int($res/256);
    if ($res != 0) {
        print STDERR "Error: could not decode \"$efile\" -- $!\n";
        $retcode = 2 if ($retcode < 2);
        unlink($tmpfile);
        return;
    }

#   chmod 0600,$tmpfile; # done already by TempFile
    return $tmpfile;
230 231 232 233 234
}



sub EncodeFile {
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
    my($dfile,$efile,$encoding) = @_;
    my($res);

    print STDERR " - encoding \"$dfile\" as \"$efile\"\n";

    if ($encoding eq "gzip") {
        if ($efile eq '-') {
            $res = system "gzip -c \Q$dfile\E";
        } else {
            $res = system "gzip -c \Q$dfile\E >\Q$efile\E";
        }
    } elsif ($encoding eq "compress") {
        if ($efile eq '-') {
            $res = system "compress <\Q$dfile\E";
        } else {
            $res = system "compress <\Q$dfile\E >\Q$efile\E";
        }
    } else {
        die "Fatal: unknown encoding \"$encoding\" at";
    }

    $res = int($res/256);
    if ($res != 0) {
        print STDERR "Error: could not encode \"$efile\" (left as \"$dfile\")\n";
        $retcode = 2 if ($retcode < 2);
        return;
    }

    return $dfile;
264 265 266 267
}



268
sub ExtensionMimetype {
269 270
    my($ext) = @_;
    my($typ);
271

272 273 274 275 276 277 278
    unless ($donemimetypes) {
        ReadMimetypes($usrmimetyp);
        ReadMimetypes($locmimetyp);
        ReadMimetypes($shrmimetyp);
        ReadMimetypes($etcmimetyp);
        $donemimetypes = 1;
    }
279

280
    $typ = $mimetypes{lc($ext)};
281

282 283
    print STDERR " - extension \"$ext\" maps to mime-type \"$typ\"\n" if $debug;
    return $typ;
284 285 286 287 288
}



sub PatternMimetype {
289 290 291 292 293 294 295 296 297 298 299 300
    my($file) = @_;
    my($key,$val);

    while (($key,$val) = each %patterntypes) {
        if ($file =~ m!$key!i) {
            print STDERR " - file \"$file\" maps to mime-type \"$val\"\n" if $debug;
            return $val;
        }
    }

    print STDERR " - file \"$file\" does not conform to any known pattern\n" if $debug;
    return;
301 302 303 304 305
}



sub FileMimetype {
306 307
    my($file) = @_;
    my($ext)  = ($file =~ m!\.([^/\.]+)$!);
308

309
    my $type;
310

311 312
    $type = ExtensionMimetype($ext) if $ext;
    $type = PatternMimetype($file) unless $type;
313

314
    return $type;
315 316 317 318
}



319
@files = ();
320
foreach (@ARGV) {
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
    print STDERR " - parsing parameter \"$_\"\n" if $debug;
    if (m!^(-h|--help)$!) {
        Usage();
        exit(0);
    } elsif (m!^--(.*?)=(.*)$!) {
        print STDERR "Warning: definition of \"$1=$2\" overrides value \"${$1}\"\n" if ($ {$1} && $ {$1} != $2);
        $ {$1}=$2;
    } elsif (m!^--(.*?)$!) {
        print STDERR "Warning: definition of \"$1=$2\" overrides value \"${$1}\"\n" if ($ {$1} && $ {$1} != 1);
        $ {$1}=1;
    } elsif (m!^[^/:]+/[^/:]+:[^/:]+:!) {
        push @files,$_;
    } elsif (m!^([^/:]+/[^/:]+):(.*)! && ! -e $_) {
        my $file = $_;
        my $type = $1;
        my $file = $2;
        my $code = EncodingForFile($file);
        push @files,"${type}:${code}:${file}";
        print STDERR " - file \"$file\" does not exist -- assuming mime-type specification of \"${type}\"\n" if $debug;
    } else {
        my $file = $_;
        my $code = EncodingForFile($file);
        my $type;
        if ($code) {
            my $efile = $file;
            $efile =~ s/\.[^\.]+$//;
            $type = FileMimetype($efile);
        } else {
            $type = FileMimetype($file);
        }
        if ($type) {
            push @files,"${type}:${code}:${file}";
        } else {
            print STDERR "Warning: unknown mime-type for \"$file\" -- using \"$defmimetyp\"\n";
            push @files,"${defmimetyp}:${code}:${file}";
        }
    }
358 359
}

360 361 362
# Pass --debug to sub-calls to this program.
$ENV{RUN_MAILCAP_DEBUG} = 1 if $debug;

363
unless ($action) {
364 365 366 367 368 369 370 371 372
       if ($0 =~ m!(^|/)(mime-)?view$!)     { $action="view";   }
    elsif ($0 =~ m!(^|/)(mime-)?see$!)      { $action="view";   }
    elsif ($0 =~ m!(^|/)(mime-)?cat$!)      { $action="cat";    }
    elsif ($0 =~ m!(^|/)(mime-)?edit$!)     { $action="edit";   }
    elsif ($0 =~ m!(^|/)(mime-)?change$!)   { $action="edit";   }
    elsif ($0 =~ m!(^|/)(mime-)?compose$!)  { $action="compose";}
    elsif ($0 =~ m!(^|/)(mime-)?print$!)    { $action="print";  }
    elsif ($0 =~ m!(^|/)(mime-)?create$!)   { $action="compose";}
    else                                    { $action="view";   }
373 374 375
}


376
$mailcaps = $ENV{MAILCAPS};
377
$mailcaps = "$ENV{HOME}/.mailcap:/etc/mailcap:/usr/local/etc/mailcap:/usr/share/etc/mailcap:/usr/etc/mailcap" unless $mailcaps;
378
foreach (split(/:/,$mailcaps)) {
379
    ReadMailcap($_);
380
}
381 382

foreach (@files) {
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    my($type,$code,$file) = m/^(.*?):(.*?):(.*)$/;
    print STDERR "Processing file \"$file\" of type \"$type\" (encoding=",$code?$code:"none",")...\n" if $debug;

    if ($file ne '-') {
        if ($action eq 'compose' || $action eq 'edit') {
            if (-e $file) {
                if (! -w $file) {
                    print STDERR "Error: no write permission for file \"$file\"\n";
                    $retcode = 2 if ($retcode < 2);
                    next;
                }
            } else {
                if (open(TEST,">$file")) {
                    close(TEST);
                    unlink($file);
                } else {
                    print STDERR "Error: no write permission for file \"$file\"\n";
                    $retcode = 2 if ($retcode < 2);
                    next;
                }
            }
        } else {
            if (! -e $file) {
                print STDERR "Error: no such file \"$file\"\n";
                $retcode = 2 if ($retcode < 2);
                next;
            }
            if (! -r $file) {
                print STDERR "Error: no read permission for file \"$file\"\n";
                $retcode = 2 if ($retcode < 2);
                next;
            }
        }
    }

    my(@matches,$entry,$res,$efile);
    if ($code) {
        $efile = $file;
        $file  = DecodeFile($efile,$code,$action);
        next unless $file;
    }

    foreach $entry (@mailcap) {
        $entry =~ m/^(.*?)\s*;/;
        $_ = "\Q$1\E"; s/\\\*/\.\*/g;
        push @matches,$entry if ($type =~ m!^$_$!i);
    }
430
    @matches = grep(/\Q$action\E=/,@matches) unless ($action eq "view" || $action eq "cat");
431 432 433 434 435 436

    my $done=0;
    my $fail=0;
    foreach $match (@matches) {
        my $comm;
        print STDERR " - checking mailcap entry \"$match\"\n" if $debug;
437
        if ($action eq "view" || $action eq "cat") {
438 439 440 441 442 443 444
            ($comm) = ($match =~ m/^.*?;\s*(.*?)\s*($|;)/);
        } else {
            ($comm) = ($match =~ m/\Q$action\E=(.*?)\s*($|;)/);
        }
        next if (!$comm || $comm =~ m!(^|/)false$!i);
        print STDERR " - program to execute: $comm\n" if $debug;

445 446
	if ($action eq 'cat' && $match !~ m/;\s*copiousoutput\s*($|;)/) {
	    print STDERR " - \"copiousoutput\" is required for \"cat\" action\n" if $debug;
447 448 449
	    $fail++;
	    next;
	}
450 451 452 453 454 455 456 457 458 459

        my($tmpfile,$tmplink);
        if ($action ne 'print' && $match =~ m/;\s*needsterminal\s*($|;)/ && ! -t STDOUT) {
            if ($ENV{DISPLAY}) {
                $comm = "$xtermprgrm -T '$file ($type)' -e $0 --action=$action '${type}:%s'";
            } else {
                print STDERR " - no terminal available for rule (needsterminal)\n" if $debug;
                $fail++;
                next;
            }
460
        } elsif ($action eq 'view' && !$nopager && $match =~ m/;\s*copiousoutput\s*($|;)/ && $type ne 'text/plain') {
461 462 463
            $comm .= " | $0 --action=$action text/plain:-";
        }

464 465 466 467 468 469 470 471 472 473 474 475
        if ($match =~ m/;\s*test=(.*?)\s*($|;)/) {
            my $test;
            print STDERR " - running test: $1 " if $debug;
            $test   = system "$1 >/dev/null 2>&1";
            $test >>= 8;
            print STDERR " (result=$test=",($test!=0?"false":"true"),")\n" if $debug;
            if ($test) {
                $fail++;
                next;
            }
        }

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
        if ($file ne "-") {
            if ($comm =~ m/[^%]%s/) {
                if ($file =~ m![^ a-z0-9,.:/@%^+=_-]!i) {
                    $match =~ m/nametemplate=(.*?)\s*($|;)/;
                    my $prefix = $1;
                    my $linked = 0;
                    while (!$linked) {
                        $tmplink = TempFile($prefix);
                        unlink($tmplink);
                        if ($file =~ m!^/!) {
                            $linked = symlink($file,$tmplink);
                        } else {
                            my $pwd = `/bin/pwd`;
                            chomp($pwd);
                            $linked = symlink("$pwd/$file",$tmplink);
                        }
                    }
                    print STDERR " - filename contains shell meta-characters; aliased to '$tmplink'\n" if $debug;
                    $comm =~ s/([^%])%s/$1$tmplink/g;
                } else {
                    $comm =~ s/([^%])%s/$1$file/g;
                }
            } else {
                if ($comm =~ m/\|/) {
                    $comm =~ s/\|/<\Q$file\E \|/;
                } else {
                    $comm .= " <\Q$file\E";
                }
                if ($action eq 'edit' || $action eq 'compose') {
                    $comm .= " >\Q$file\E";
                }
            }
        } else {
            if ($comm =~ m/[^%]%s/) {
                $tmpfile = SaveStdin($match);
                $comm =~ s/([^%])%s/$1$tmpfile/g;
            } else {
                # no name means same as "-"... read from stdin
            }
        }

        $comm =~ s!([^%])%t!$1$type!g;
        $comm =~ s!([^%])%F!$1!g;
        $comm =~ s!%{(.*?)}!$_="'$ENV{$1}'";s/\`//g;s/\'\'//g;$_!ge;
        $comm =~ s!\\(.)!$1!g;
        $comm =~ s!\'\'!\'!g;
        $comm =~ s!$quotedsemi!;!go;
        $comm =~ s!$quotedprct!%!go;

        print STDERR " - executing: $comm\n" if $debug;
526 527 528 529 530 531 532
	if ($norun) {
	    print $comm,"\n";
	    $res = 0;
	} else {
	    $res = system $comm;
	    $res = int($res/256);
	}
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
        if ($res != 0) {
            print STDERR "Warning: program returned non-zero exit code \#$res\n";
            $retcode = $res;
        }
        $done=1;
        unlink $tmpfile if $tmpfile;
        unlink $tmplink if $tmplink;
        last;
    }

    if (!$done) {
        if ($fail) {
            print STDERR "Error: no \"$action\" rule for type \"$type\" passed its test case\n";
            print STDERR "       (for more information, add \"--debug=1\" on the command line)\n";
            $retcode = 3 if ($retcode < 3);
        } else {
            print STDERR "Error: no \"$action\" mailcap rules found for type \"$type\"\n";
            $retcode = 3 if ($retcode < 3);
        }
        unlink $file if $code;
        $retcode = 1 unless $retcode;
        next;
    }

    if ($code) {
        if ($action eq 'edit' || $action eq 'compose') {
            my $file = EncodeFile($file,$efile,$code);
            unlink $file if $file;
        } else {
            unlink $file;
        }
    }
565
}
566 567

exit($retcode);