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 @pics = `find "$_" -type f -name "*.jpg"`;
 134
 135     chomp @pics;
 136
 137     push @images, @pics;
 138     push @{$opts{bgdircnt}}, scalar @pics;
 139
 140     $totals{bgdirs}++;
 141   } # for
 142
 143   $totals{images} = scalar @images;
 144
 145   return @images;
 146 } # fillPictures
 147
 148 sub updateSetBG ($$) {
 149   my ($bgimage, $lockimage) = @_;
 150
 151   open my $setbg, '>', "$ENV{HOME}/.$FindBin::Script"
 152     or error "Unable to open $ENV{HOME}/.$FindBin::Script for writing - $!", 1;
 153
 154   display $bgimage, $setbg;
 155
 156   close $setbg;
 157
 158   my $msg  = localtime() . ":$bgimage";
 159      $msg .= " lock:$lockimage" if $opts{lockscreen};
 160
 161   open my $hist, '>>', "$ENV{HOME}/.$FindBin::Script.hist"
 162     or error "Unable to open $ENV{HOME}/.$FindBin::Script.hist for append - $!", 1;
 163
 164   display $msg, $hist;
 165
 166   close $hist;
 167
 168   return;
 169 } # updateSetBG
 170
 171 sub SwitchWallPaper {
 172   # We don't need to do anything here, just handle the interrupt and
 173   # let the while loop continue.
 174   debug 'SwitchWallPaper: Interrupt received';
 175   displayStats;
 176
 177   return;
 178 } # SwitchWallPaper
 179
 180 ## Main
 181 verbose "$FindBin::Script v$VERSION";
 182
 183 my @argvCopy = @ARGV;
 184
 185 GetOptions (
 186   \%opts,
 187   'usage',
 188   'help',
 189   'verbose',
 190   'debug',
 191   'sleep=i',
 192   'lockscreen',
 193   'bgdirs=s@',
 194 ) || Usage;
 195
 196 local $0 = "$FindBin::Script " . join ' ', @argvCopy;
 197
 198 for my $process (@{$processes->table}) {
 199   if ($process->cmndline =~ /setbg/ and
 200       $process->pid != $$) {
 201     kill 12, $process->pid;
 202
 203     exit 0;
 204   } # if
 205 } # for
 206
 207 for (my $i = 0; $i < scalar @{$opts{bgdirs}}; $i++) {
 208   error "$opts{bgdirs}[$i] is not a directory", 1 unless -d $opts{bgdirs}[$i];
 209
 210   $opts{bgdirs}[$i] = File::Spec->rel2abs ($opts{bgdirs}[$i]);
 211 } # for
 212
 213 # Using gsettings
 214 my $setbg       = "gsettings";
 215 my $setbgOpts   = "set org.gnome.desktop.background picture-uri \"file://";
 216 my $setLockOpts = "set org.gnome.desktop.screensaver picture-uri \"file://";
 217
 218 my @images = fillPictures;
 219
 220 Usage "No images to display. Must specify -bgdirs" unless @images;
 221
 222 $SIG{USR2} = \&SwitchWallPaper;
 223 $SIG{USR1} = \&fillPictures;
 224
 225 my $debugger = $DB::OUT;
 226 my $today;
 227
 228 truncate "$ENV{HOME}/.$FindBin::Script.hist", 0;
 229
 230 EnterDaemonMode unless defined $DB::OUT;
 231
 232 while () {
 233   my $bgimage   = escapeHTML ($images[int (rand $#images)]);
 234   my $lockimage = escapeHTML ($images[int (rand $#images)]);
 235
 236   my $cmd = "$setbg $setbgOpts$bgimage\" 2> /dev/null";
 237
 238   my @output = `$cmd`;
 239
 240   if ($? != 0) {
 241     error "Trying to set background - command used \"$cmd\"\n\nOutput\n\n" .
 242       join "\n", @output;
 243     $totals{errors}++;
 244   } else {
 245     $totals{'Images displayed'}++;
 246   } # if
 247
 248   if ($opts{lockscreen}) {
 249     $cmd = "$setbg $setLockOpts$lockimage\" 2> /dev/null";
 250
 251     @output = `$cmd`;
 252
 253     if ($? != 0) {
 254       error "Trying to set lock screen - command used \"$cmd\"\n\nOutput\n\n" .
 255         join "\n", @output;
 256       $totals{errors}++;
 257     } else {
 258       $totals{'Lock screens displayed'}++;
 259     } # if
 260   } # if
 261
 262   updateSetBG $bgimage, $lockimage;
 263
 264   displayStats;
 265
 266   $today = YMD;
 267
 268   sleep $opts{sleep} * 60;
 269
 270   if ($today ne YMD){
 271     @images = fillPictures;
 272
 273     displayStats;
 274   } # if
 275 } # while