stodo

   1 #! /usr/bin/perl
   2 # stodo commits the changes made to a subversion backed todo db, and
   3 # is released under the terms of the GPL version 2, or any later
   4 # version, at your option. See the file README and COPYING for more
   5 # information. Copyright 2004 by Don Armstrong <don@donarmstrong.com>.
   6 # $Id$
   7
   8
   9 use warnings;
  10 use strict;
  11
  12
  13 use Getopt::Long;
  14 use Pod::Usage;
  15
  16 =head1 NAME
  17
  18 stodo - devtodo event script which attempts to commit the changes made to a .todo file after a change
  19
  20 =head1 SYNOPSIS
  21
  22 stodo [options]
  23
  24  Options:
  25   --simulate, -s simulate: don't actually do anything
  26   --quiet, -q don't output to STDOUT
  27   --debug, -d debugging level (Default 0)
  28   --help, -h display this help
  29   --man, -m display manual
  30
  31 =head1 OPTIONS
  32
  33 =over
  34
  35 =item B<--simulate, -s>
  36
  37 Simulation mode, don't actually commit anything.
  38
  39 =item B<--quiet, -q>
  40
  41 Don't output anything to STDOUT
  42
  43 =item B<--debug, -d>
  44
  45 Debug verbosity. (Default 0)
  46
  47 =item B<--help, -h>
  48
  49 Display brief useage information.
  50
  51 =item B<--man, -m>
  52
  53 Display this manual.
  54
  55 =back
  56
  57 =head1 ENVIRONMENTAL VARIABLES
  58
  59 =over
  60
  61 =item B<TODODB>
  62
  63 Todo databse location, set by devtodo
  64
  65 =item B<STODO_NO_COMMIT>
  66
  67 If set, stodo assumes that there is no network, and doesn't commit
  68
  69 =back
  70
  71 =head1 EXAMPLES
  72
  73  on save {
  74     exec stodo
  75  }
  76
  77
  78 =cut
  79
  80
  81
  82 use Cwd qw(cwd);
  83 use IO::File;
  84 use XML::Simple;
  85 use IO::Handle;
  86 use Data::Diff qw(Diff);
  87 use File::Basename qw(dirname basename);
  88
  89 use vars qw($DEBUG);
  90
  91 # XXX parse config file
  92
  93 my %options = (quiet           => 0,
  94                debug           => 0,
  95                help            => 0,
  96                man             => 0,
  97                simulate        => 0,
  98               );
  99
 100 GetOptions(\%options,'debug|d+','help|h|?','man|m','quiet|q+','simulate|s+');
 101
 102 pod2usage() if $options{help} or not exists $ENV{TODODB};
 103 pod2usage({verbose=>2}) if $options{man};
 104
 105 $DEBUG = $options{debug};
 106
 107 # Figure out what we're doing
 108 my $tododb = exists $ENV{TODODB} ? $ENV{TODODB} : '.todo';
 109 if ($tododb !~ m#^/#) {
 110      $tododb = cwd().'/'.$tododb;
 111 }
 112 if (not -r $tododb) {
 113      "$tododb does not exist or is not readable";
 114 }
 115 $tododb = full_readlink($tododb);
 116 my $base_dir = dirname($tododb);
 117 my $tododb_name = basename($tododb);
 118
 119 if (not -e "$base_dir/.svn") {
 120      print "$base_dir/.svn doesn't exist, not commiting\n" unless $options{quiet};
 121      exit 0;
 122 }
 123
 124 if (not -e "$base_dir/.svn/text-base/${tododb_name}.svn-base") {
 125      print "$base_dir/.svn/text-base/${tododb_name}.svn-base doesn't exist, not committing\n" unless $options{quiet};
 126      exit 0;
 127 }
 128
 129 # Make sure that we can ping the subversion server
 130 my $svn_entries_fh = new IO::File "$base_dir/.svn/entries",'r'
 131      or die "unable to open $base_dir/.svn/entries: $!";
 132 my $url_type;
 133 my $svn_host;
 134 while (<$svn_entries_fh>) {
 135      next unless m#^(?:\s+url=\")?(http|svn\+ssh|file):///?([^\/]+)#;
 136      $url_type = $1;
 137      last if $url_type eq 'file';
 138      $svn_host = $2;
 139      last;
 140 }
 141 if ($ENV{STODO_NO_COMMIT}) {
 142      print "Exiting because of STODO_NO_COMMIT env variable\n" unless $options{quiet};
 143      exit 0;
 144 }
 145 if (not defined $svn_host and (not defined $url_type or $url_type ne 'file')) {
 146      die "Was unable to find which host the svn repository is located on";
 147 }
 148 if ($url_type ne 'file') {
 149      qx(ping -q -c 3 $svn_host >/dev/null 2>&1);
 150      if ($? != 0) {
 151           print "Unable to ping $svn_host\n" unless $options{quiet};
 152           exit 0 unless $options{simulate};
 153      }
 154 }
 155
 156
 157 # See what has changed
 158 #my $svn_fh = new IO::Handle;
 159 #open($svn_fh,'-|','svn','diff',$tododb) or die "Unable to execute svn diff $tododb; $!";
 160 #while (<$svn_fh>) {
 161 #     next unless /^[-+]/;
 162 #}
 163
 164 my $todo_db_old = fix_content(XMLin("$base_dir/.svn/text-base/${tododb_name}.svn-base",KeyAttr=>'time')->{note});
 165 my $todo_db_new = fix_content(XMLin($tododb,KeyAttr=>'time')->{note});
 166
 167 my @commit_message;
 168
 169 my $diff = Diff($todo_db_new,$todo_db_old);
 170
 171 #use Data::Dumper;
 172 #print Dumper($diff);
 173
 174 if (exists $diff->{uniq_a}) {
 175      foreach (values %{$diff->{uniq_a}}) {
 176           my ($content,$priority) = map {s/^\s*|\s*$//g; s/\n/ /g; $_;} @{$_}{qw(content priority)};
 177           push @commit_message,qq( * Added todo: [$priority] $content);
 178      }
 179 }
 180
 181 if (exists $diff->{uniq_b}) {
 182      foreach (values %{$diff->{uniq_b}}) {
 183           my ($content,$priority) = map {s/^\s*|\s*$//g; s/\n/ /g; $_;} @{$_}{qw(content priority)};
 184           push @commit_message,qq( * Deleted todo: [$priority] $content);
 185      }
 186 }
 187
 188 if (exists $diff->{diff}) {
 189      # This entry has either been edited, completed, or uncompleted
 190      foreach my $entry_key (keys %{$diff->{diff}}) {
 191           my ($content,$priority) = map {s/^\s*|\s*$//g; s/\n/ /g; $_;} @{$todo_db_new->{$entry_key}}{qw(content priority)};
 192           my $diff_entry = $diff->{diff}{$entry_key};
 193           if (exists $diff_entry->{uniq_a} and exists $diff_entry->{uniq_a}{done}) {
 194                push @commit_message,qq( * Finished todo: [$priority] $content);
 195           }
 196           if (exists $diff_entry->{uniq_a} and exists $diff_entry->{uniq_b}{done}) {
 197                push @commit_message,qq( * Marked as undone: [$priority] $content);
 198           }
 199           if (exists $diff_entry->{diff}) {
 200                my @what_changed;
 201                if (exists $diff_entry->{diff}{content}) {
 202                     push @what_changed,'content';
 203                }
 204                if (exists $diff_entry->{diff}{priority}) {
 205                     push @what_changed,'priority';
 206                }
 207                if (not @what_changed) {
 208                     @what_changed = keys %{$diff_entry->{diff}};
 209                }
 210                push @commit_message,qq( * Todo changed ).join(' and ',@what_changed).qq( [$priority] $content);
 211           }
 212      }
 213 }
 214
 215 if (exists $diff->{same}) {
 216      foreach my $entry_key (keys %{$diff->{same}}) {
 217           my ($content,$priority) = map {s/^\s*|\s*$//g; s/\n/ /g; $_;} @{$todo_db_new->{$entry_key}}{qw(content priority)};
 218           my $diff_entry = $diff->{same}{$entry_key};
 219           if (exists $diff_entry->{uniq_a} and exists $diff_entry->{uniq_a}{done}) {
 220                push @commit_message,qq( * Finished todo: [$priority] $content);
 221           }
 222           if (exists $diff_entry->{uniq_a} and exists $diff_entry->{uniq_b}{done}) {
 223                push @commit_message,qq( * Marked as undone: [$priority] $content);
 224           }
 225           if (exists $diff_entry->{diff}) {
 226                my @what_changed;
 227                if (exists $diff_entry->{diff}{content}) {
 228                     push @what_changed,'content';
 229                }
 230                if (exists $diff_entry->{diff}{priority}) {
 231                     push @what_changed,'priority';
 232                }
 233                if (not @what_changed) {
 234                     @what_changed = keys %{$diff_entry->{diff}};
 235                }
 236                push @commit_message,qq( * Todo changed ).join(' and ',@what_changed).qq( [$priority] $content);
 237           }
 238      }
 239 }
 240
 241
 242 if (not @commit_message) {
 243      print "No commit message\n" if $DEBUG or $options{simulate};
 244      exit 0;
 245 }
 246
 247 my $commit_message = join('', map {qq($_\n)} @commit_message);
 248 if ($options{simulate}) {
 249      print "svn commit -F - $tododb <<EOF\n";
 250      print $commit_message;
 251      print "EOF\n";
 252 }
 253 else {
 254      system('svn','commit','-m',$commit_message,$tododb);
 255 }
 256
 257
 258 # Commit the changes with an appropriate commit message
 259
 260
 261 sub fix_content {
 262      my ($s) = @_;
 263      if (not ref(${[values %{$s}]}[0]) eq 'HASH') {
 264           $s = {$s->{time} => $s};
 265      }
 266      foreach my $entry (values %{$s}) {
 267           if (exists $entry->{content}) {
 268                $entry->{content} =~ s/^\s*|\s*$//g;
 269           }
 270           if (exists $entry->{comment}) {
 271                $entry->{comment} =~ s/^\s*|\s*$//g;
 272           }
 273      }
 274      return $s;
 275 }
 276
 277
 278 sub full_readlink {
 279      my ($file) = @_;
 280      while (-l $file) {
 281           $file = readlink $file;
 282      }
 283
 284      return $file;
 285 }
 286
 287 __END__