bin/setbg

   1 #!/usr/bin/perl
   2
   3 =pod
   4
   5 =head1 NAME $RCSfile: setbg,v $
   6
   7 Set background
   8
   9 =head1 VERSION
  10
  11 =over
  12
  13 =item Author
  14
  15 Andrew DeFaria <Andrew@ClearSCM.com>
  16
  17 =item Revision:
  18
  19 $Revision: 1.10 $
  20
  21 =item Created:
  22
  23 Fri Mar 18 01:14:38 PST 2005
  24
  25 =item Modified:
  26
  27 $Date: 2012/11/09 15:31:30 $
  28
  29 =back
  30
  31 =head1 SYNOPSIS
  32
  33  Usage: setbg [-u|sage] [-h|elp] [-ve|rbose] [-d|ebug] [-s|leep <n>]
  34               [-bgdirs <bgdir> -bgdirs ...]
  35
  36  Where:
  37
  38  -u|sage:      Displays this usage
  39  -h|elp:       Display full help
  40  -ve|rbose:    Be verbose
  41  -d|ebug:      Output debug messages
  42
  43  -s|leep:      Number of minutes to sleep between setting the background
  44                (Default: 1 hour)
  45  -l|ockscreen: Change lockscreen backround (Default: False)
  46  -b|gdirs:     Directories to scan for images
  47
  48 =head1 DESCRIPTION
  49
  50 This script sets the background image randomly based on images found in bgdirs.
  51 Note if this script is run again it senses that it was previously run and sends
  52 the previous script a SIGUSR2 which the script intrprets as "Change the
  53 background now", then exits.
  54
  55 Data is written to the following files:
  56
  57  ~/.setbg:      Contains the filename of the current background image
  58  ~/.setbg.hist  Contains a history of all images displayed for this run
  59  ~/.setbg.stats Contains statistical information for the current run
  60
  61 Also note that this script will process a SIGUSR1 to mean "re-evaluate the
  62 contents of the bgdirs incase it has changed and display a new image". This is
  63 useful for script to be able to alert setbg that something has changed. For
  64 example, a script named rmbg might look at ~/.setbg to get the name of the
  65 current background image file and remove it then signal setbg with SIGUSR1 to
  66 have it re-evaluate the state of bgdirs.
  67
  68 Finally setbg will perform the this re-evaluation at midnight everyday. This is
  69 useful because we point setbg to look at -bgdirs from Dropbox where Camera
  70 Uploads is included and new pictures can arrive everyday.
  71
  72 =cut
  73
  74 use strict;
  75 use warnings;
  76
  77 use FindBin;
  78 use Getopt::Long;
  79 use Proc::ProcessTable;
  80 use File::Spec;
  81 use CGI qw/:standard/;
  82
  83 use lib "$FindBin::Bin/../lib";
  84
  85 use Pod::Usage;
  86
  87 use DateUtils;
  88 use Display;
  89 use Logger;
  90 use Utils;
  91
  92 my $VERSION  = '$Revision: 1.12 $';
  93   ($VERSION) = ($VERSION =~ /\$Revision: (.*) /);
  94
  95 my $processes = Proc::ProcessTable->new;
  96 my %opts = (
  97   sleep      => 60,
  98   lockscreen => 0,
  99   usage      => sub { pod2usage },
 100   help       => sub { pod2usage (-verbose => 2)},
 101   verbose    => sub { set_verbose },
 102   debug      => sub { set_debug },
 103 );
 104
 105 my %totals;
 106
 107 sub displayStats () {
 108   my $statsFile = Logger->new(
 109     name      => ".$FindBin::Script.stats",
 110     path      => $ENV{HOME},
 111     extension => '',
 112   );
 113
 114   $statsFile->log('At ' . localtime());
 115   $statsFile->log('Sleep: ' . $opts{sleep});
 116   $statsFile->log('Image directories:');
 117
 118   for (my $i = 0; $i < scalar @{$opts{bgdirs}}; $i++) {
 119     $statsFile->log("\t$opts{bgdirs}[$i]: $opts{bgdircnt}[$i]")
 120   } # for
 121
 122   Stats \%totals, $statsFile;
 123
 124   return;
 125 } # displayStats
 126
 127 sub fillPictures () {
 128   my @images;
 129
 130   $totals{bgdirs} = 0;
 131
 132   for (@{$opts{bgdirs}}) {
 133     my ($status, @pics) = Execute "find \"$_\" -type f";
 134
 135     chomp @pics;
 136
 137     push @images, grep(/jpg$|png$|gif$/i, @pics);
 138
 139     push @{$opts{bgdircnt}}, scalar @pics;
 140
 141     $totals{bgdirs}++;
 142   } # for
 143
 144   $totals{images} = scalar @images;
 145
 146   return @images;
 147 } # fillPictures
 148 sub writeHistory($) {
 149   my ($msg) = @_;
 150
 151   open my $hist, '>>', "$ENV{HOME}/.$FindBin::Script.hist"
 152     or error "Unable to open $ENV{HOME}/.$FindBin::Script.hist for append - $!", 1;
 153
 154   $msg = localtime() . $msg;
 155
 156   display $msg, $hist;
 157
 158   close $hist;
 159 } # writeHistory
 160
 161 sub updateSetBG($$) {
 162   my ($bgimage, $lockimage) = @_;
 163
 164   open my $setbg, '>', "$ENV{HOME}/.$FindBin::Script"
 165     or error "Unable to open $ENV{HOME}/.$FindBin::Script for writing - $!", 1;
 166
 167   display $bgimage, $setbg;
 168
 169   close $setbg;
 170
 171   my $msg  = ":$bgimage";
 172      $msg .= " lock:$lockimage" if $opts{lockscreen};
 173
 174   writeHistory $msg;
 175
 176   return;
 177 } # updateSetBG
 178
 179 sub SwitchWallPaper {
 180   # We don't need to do anything here, just handle the interrupt and
 181   # let the while loop continue.
 182   debug 'SwitchWallPaper: Interrupt received';
 183   displayStats;
 184
 185   return;
 186 } # SwitchWallPaper
 187
 188 ## Main
 189 verbose "$FindBin::Script v$VERSION";
 190
 191 my @argvCopy = @ARGV;
 192
 193 GetOptions (
 194   \%opts,
 195   'usage',
 196   'help',
 197   'verbose',
 198   'debug',
 199   'sleep=i',
 200   'lockscreen',
 201   'bgdirs=s@',
 202 ) || Usage;
 203
 204 local $0 = "$FindBin::Script " . join ' ', @argvCopy;
 205
 206 for my $process (@{$processes->table}) {
 207   if ($process->cmndline =~ /setbg/ and
 208       $process->pid != $$) {
 209     kill 12, $process->pid;
 210
 211     exit 0;
 212   } # if
 213 } # for
 214
 215 for (my $i = 0; $i < scalar @{$opts{bgdirs}}; $i++) {
 216   error "$opts{bgdirs}[$i] is not a directory", 1 unless -d $opts{bgdirs}[$i];
 217
 218   $opts{bgdirs}[$i] = File::Spec->rel2abs ($opts{bgdirs}[$i]);
 219 } # for
 220
 221 # Using gsettings
 222 my $setbg       = "gsettings";
 223 my $setbgOpts   = "set org.gnome.desktop.background picture-uri \"file://";
 224 my $setLockOpts = "set org.gnome.desktop.screensaver picture-uri \"file://";
 225
 226 my @images = fillPictures;
 227
 228 Usage "No images to display. Must specify -bgdirs" unless @images;
 229
 230 $SIG{USR2} = \&SwitchWallPaper;
 231 $SIG{USR1} = \&fillPictures;
 232
 233 my $debugger = $DB::OUT;
 234 my $today;
 235
 236 truncate "$ENV{HOME}/.$FindBin::Script.hist", 0;
 237
 238 EnterDaemonMode unless defined $DB::OUT;
 239
 240 my $pickNewImages = 1;
 241
 242 while () {
 243   my ($bgimage, $lockimage);
 244
 245   if ($pickNewImages) {
 246     $bgimage   = escapeHTML ($images[int (rand $#images)]);
 247     $lockimage = escapeHTML ($images[int (rand $#images)]);
 248   } # if
 249
 250   my $monitorIsOn;
 251
 252   my ($status, @output) = Execute("xset q | grep Monitor | awk '{print \$3}'");
 253
 254   if ($status or $output[0] eq 'Off') {
 255     writeHistory ":Monitor off, not setting background to $bgimage - will keep trying";
 256
 257     $pickNewImages = 0;
 258   } else {
 259     $pickNewImages = 1;
 260
 261     my $cmd = "$setbg $setbgOpts$bgimage\" 2> /dev/null";
 262
 263     ($status, @output) = Execute $cmd;
 264
 265     if ($status) {
 266       error "Trying to set background - command used \"$cmd\"\n\nOutput\n\n" .
 267         join "\n", @output;
 268       $totals{errors}++;
 269     } else {
 270       $totals{'Images displayed'}++;
 271     } # if
 272
 273     if ($opts{lockscreen}) {
 274       $cmd = "$setbg $setLockOpts$lockimage\" 2> /dev/null";
 275
 276       ($status, @output) = Execute $cmd;
 277
 278       if ($status != 0) {
 279         error "Trying to set lock screen - command used \"$cmd\"\n\nOutput\n\n" .
 280           join "\n", @output;
 281         $totals{errors}++;
 282       } else {
 283         $totals{'Lock screens displayed'}++;
 284       } # if
 285     } # if
 286
 287     updateSetBG $bgimage, $lockimage;
 288
 289     displayStats;
 290   } # if
 291
 292   $today = YMD;
 293
 294   sleep $opts{sleep} * 60;
 295
 296   if ($today ne YMD){
 297     @images = fillPictures;
 298
 299     displayStats;
 300   } # if
 301 } # while