2 # Copyright © 2001, 2002, 2003 Jamie Zawinski <jwz@jwz.org>.
4 # Permission to use, copy, modify, distribute, and sell this software and its
5 # documentation for any purpose is hereby granted without fee, provided that
6 # the above copyright notice appear in all copies and that both that
7 # copyright notice and this permission notice appear in supporting
8 # documentation. No representations are made about the suitability of this
9 # software for any purpose. It is provided "as is" without express or
12 # This program attempts to locate a random image from the specified directory,
13 # and load it on to the root window, using some other program that can decode
14 # image files. (It attempts to find such a program.)
16 # The various xscreensaver hacks that manipulate images ("slidescreen",
17 # "jigsaw", etc.) get the image to manipulate by running the
18 # "xscreensaver-getimage" program.
20 # "xscreensaver-getimage" will invoke this program, depending on the
21 # value of the "chooseRandomImages" and "imageDirectory" settings in
22 # the ~/.xscreensaver file (or /usr/lib/X11/app-defaults/XScreenSaver).
34 # Apparently the "old way" to get S_ISLNK and friends is to do this:
38 # But apparently the "new way" is to do this:
42 # but of course that will generate an error on "old" (pre-5.6?) Perl versions.
43 # So we do it like this instead:
46 if (! defined(&S_ISLNK)) { # perhaps defined by "POSIX"?
48 import Fcntl ':mode'; # if not, look for it in "Fcntl".
53 my $progname = $0; $progname =~ s@.*/@@g;
54 my $version = q{ $Revision: 1.13 $ }; $version =~ s/^[^0-9]+([0-9.]+).*$/$1/;
58 # This matches files that we are allowed to use as images (case-insensitive.)
59 # Anything not matching this is ignored. This is so you can point your
60 # imageDirectory at directory trees that have things other than images in
61 # them, but it assumes that you gave your images sensible file extensions.
63 my $good_file_re = '\.(gif|p?jpe?g|png|tiff?|xbm|xpm)$';
66 # These are programs that can be used to put an image file on the root
67 # window (including virtual root windows.) The first one of these programs
68 # that exists on $PATH will be used (with the file name as the last arg.)
70 # If you add other programs to this list, please let me know!
73 "chbg -once -xscreensaver -max_grow 4 -max_size 100",
74 "xv -root -quit -viewonly -maxpect +noresetroot -quick24 -rmode 5" .
75 " -rfg black -rbg black",
76 "xli -quiet -fullscreen -onroot -center -border black",
77 "xloadimage -quiet -fullscreen -onroot -center -border black",
79 # this lame program wasn't built with vroot.h:
80 # "xsri -scale -keep-aspect -center-horizontal -center-vertical",
87 foreach my $cmd (@programs) {
89 my ($name) = m/^([^ ]+)/;
90 push @names, "\"$name\"";
91 print STDERR "$progname: looking for $name...\n" if ($verbose > 2);
92 foreach my $dir (split (/:/, $ENV{PATH})) {
93 print STDERR "$progname: checking $dir/$name\n" if ($verbose > 3);
94 return $cmd if (-x "$dir/$name");
98 $names[$#names] = "or " . $names[$#names];
99 printf STDERR "$progname: none of: " . join (", ", @names) .
100 " were found on \$PATH.\n";
113 print STDERR "$progname: reading dir $dir/...\n" if ($verbose > 2);
116 if (! opendir (DIR, $dir)) {
117 print STDERR "$progname: couldn't open $dir: $!\n" if ($verbose);
120 my @files = readdir (DIR);
125 foreach my $file (@files) {
126 next if ($file =~ m/^\./); # ignore dot files/dirs
128 $file = "$dir/$file";
129 my @st = stat($file);
130 my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size,
131 $atime,$mtime,$ctime,$blksize,$blocks) = @st;
135 my $ll = readlink $file;
137 print STDERR "$progname: dangling symlink: $file -> $ll\n";
139 print STDERR "$progname: unreadable: $file\n";
145 next if ($seen_inodes{$ino}); # break symlink loops
146 $seen_inodes{$ino} = 1;
148 if (S_ISDIR($mode)) {
151 print STDERR "$progname: found dir $file\n" if ($verbose > 2);
152 } elsif (S_ISREG($mode) || S_ISLNK($mode)) {
154 if ($file =~ m/[~%\#]$/ || # backup file, or
155 ! ($file =~ m/$good_file_re/io)) { # no image extension
157 print STDERR "$progname: skip file $file\n" if ($verbose > 2);
159 push @all_files, $file;
160 print STDERR "$progname: found file $file\n" if ($verbose > 2);
162 } elsif ($verbose > 2) {
163 print STDERR "$progname: nonreg $file\n";
173 sub find_random_file {
178 print STDERR "$progname: recursively reading $dir...\n" if ($verbose > 1);
179 find_all_files ($dir);
180 print STDERR "$progname: found " . ($#all_files+1) .
181 " file" . ($#all_files == 0 ? "" : "s") .
182 " in $dir_count dir" . ($dir_count == 1 ? "" : "s") .
183 "; skipped $skip_count file" . ($skip_count == 1 ? "" : "s") .
187 @all_files = sort(@all_files);
189 if ($#all_files < 0) {
190 print STDERR "$progname: no files in $dir\n";
194 my $n = int (rand ($#all_files + 1));
195 my $file = $all_files[$n];
197 print STDERR "$progname: chose file $n: $file\n" if ($verbose > 1);
204 my ($file, $displayer) = @_;
206 if (!defined($displayer)) {
207 print STDOUT "$file\n";
209 my @cmd = split (/ +/, $displayer);
210 push @cmd, $file; # do it this way to allow file names with spaces.
211 print STDERR "$progname: executing \"" . join(" ", @cmd) . "\"\n"
218 sub find_and_display {
219 my ($dir, $displayer) = @_;
220 my $file = find_random_file ($dir);
221 display_file ($file, $displayer);
226 print STDERR "usage: $progname [--verbose] [--name] directory\n";
227 print STDERR "Puts a randomly selected image on the root window.\n";
228 print STDERR "With --name, merely prints the filename to stdout.\n";
236 while ($_ = $ARGV[0]) {
238 if ($_ eq "--verbose") { $verbose++; }
239 elsif (m/^-v+$/) { $verbose += length($_)-1; }
240 elsif ($_ eq "--name") { $do_name++; }
241 elsif (m/^-./) { usage; }
242 elsif (!defined($dir)) { $dir = $_; }
246 usage unless (defined($dir));
247 my $displayer = undef;
249 $displayer = pick_displayer() unless $do_name;
252 find_and_display ($dir, $displayer);
254 display_file ($dir, $displayer);