gtdo.pl

   1 #!/usr/bin/perl -w
   2 use strict;
   3
   4 #### Copyright 2008, Devendra Gera <gera@theoldmonk.net>,
   5 #### All rights reserved.
   6 ####
   7 #### This is Free Software, released under the terms of the GNU General Public
   8 #### License, version 2. A copy of the license can be obtained by emailing the
   9 #### author, or from http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
  10 ####
  11 #### As noted in the License, this software does not come with any warranty,
  12 #### explicit or implied. This program might, and would be buggy. Use it at
  13 #### your own risk.
  14
  15 use Pod::Usage;
  16 use Fcntl qw(:flock);
  17
  18 my $todo_file = "$ENV{HOME}/todo/todo.txt";
  19 my $done_file = "$ENV{HOME}/todo/done.txt";
  20
  21 my %dispatch = (
  22         add             => \&add_task,
  23         ls              => \&list_tasks,
  24         do              => \&do_task,
  25         contexts        => \&list_contexts,
  26         groups          => \&list_groups,
  27 );
  28 my @tasks;
  29
  30 my $command = shift;
  31 pod2usage()
  32         unless ( (defined $command) && (exists $dispatch{$command}) );
  33
  34 read_tasks();
  35 $dispatch{$command}->(@ARGV);
  36
  37 exit(0);
  38
  39 sub add_task
  40 {
  41         my $task = join (" ", @_);
  42         quit("") unless $task;
  43
  44         # find out the group of the task
  45         my (undef, $group) = ( $task =~ m{(^|\s)(/\S*)(\s|$)} );
  46         $group |= "";
  47         my ($parent, $number) = ( $group =~ /(.*?)\.(\d+)/ );
  48
  49         my $target_offset = @tasks;
  50
  51         # insert properly if its a subtask
  52         if(defined $parent) {
  53
  54                 # also remember to strip the number
  55                 $task =~ s/$parent\.$number/$parent/;
  56
  57                 my @candidate_ids = grep_pos_in_tasks($parent, ());
  58                 my $length = @candidate_ids;
  59
  60                 if( $number <= $length ) {
  61                         $target_offset = $candidate_ids[$number - 1] - 1;
  62                 }
  63         }
  64
  65         splice @tasks, $target_offset, 0, ($task);
  66
  67         write_tasks();
  68 }
  69
  70 sub list_tasks
  71 {
  72         my @patterns = @_;
  73         @patterns = ("") unless @patterns;
  74         my $is_a_group = 0;
  75
  76         my @candidates = ();
  77         foreach my $pattern ( @patterns ) {
  78                 $is_a_group = 1 if( $pattern =~ m{^/} );
  79                 @candidates = grep_pos_in_tasks( $pattern, @candidates );
  80         }
  81
  82         # list tasks only if they are the first task from their group.
  83         my %out;
  84         my $i = 0;
  85         foreach my $id ( @candidates ) {
  86                 unless ($is_a_group) {
  87                         my (undef,$group) = ( $tasks[$id - 1] =~ m{(^|\s)(/\S*)(\s|$)} );
  88                         if(defined $group) {
  89                                 my $first = (grep_pos_in_tasks( $group, () ))[0];
  90                                 $out{$group} = $id if ($id == $first);
  91                                 next;
  92                         }
  93                 }
  94                 $out{$i++} = $id;
  95         }
  96
  97         foreach my $id ( sort { $a <=> $b } values %out ) {
  98                 print STDOUT "$id : $tasks[$id - 1]", "\n";
  99         }
 100 }
 101
 102 sub do_task
 103 {
 104         my $num = shift;
 105
 106         quit("invalid task number") unless ((defined $num) && ($num =~ /^\d+$/));
 107         quit("") if ($num > @tasks);
 108
 109         my $task = splice @tasks, $num - 1, 1;
 110         append_done($task);
 111         write_tasks();
 112 }
 113
 114 sub read_tasks
 115 {
 116         open TODO, "<$todo_file" or return;
 117
 118         while(<TODO>) {
 119                 chomp;
 120                 next unless $_;
 121                 push @tasks, $_;
 122         }
 123
 124         close TODO;
 125 }
 126
 127 sub write_tasks
 128 {
 129         open LOCK, ">$todo_file.lock" or quit("cannot open lock file : $!");
 130         flock LOCK, LOCK_EX;
 131
 132         open TODO, ">$todo_file.$$" or quit("cannot open $todo_file.$$ : $!");
 133         print TODO join( "\n", @tasks );
 134         close TODO;
 135
 136         rename( "$todo_file.$$", $todo_file ) or quit("cannot rename : $!");
 137
 138         flock LOCK, LOCK_UN;
 139         close LOCK;
 140 }
 141
 142 sub grep_pos_in_tasks
 143 {
 144         my $pattern = shift;
 145         my @positions = @_;
 146
 147         @positions = ( 1 .. scalar(@tasks) ) if( @positions < 1 );
 148
 149         my @ret = ();
 150         foreach my $pos ( @positions ) {
 151                 push @ret, $pos if ( $tasks[$pos - 1] =~ /$pattern/ );
 152         }
 153
 154         return @ret;
 155 }
 156
 157 sub append_done
 158 {
 159         my $task = shift or quit("no task to append!");
 160         my ($day, $mon, $year) = (localtime) [3 .. 5];
 161         $mon ++;
 162         $year += 1900;
 163
 164         open LOCK, ">$done_file.lock" or quit("cannot open lock file : $!");
 165         flock LOCK, LOCK_EX;
 166
 167         open DONE, ">>$done_file" or quit("cannot open $done_file.$$ : $!");
 168         print DONE "$year-$mon-$day : $task", "\n";
 169         close DONE;
 170
 171         flock LOCK, LOCK_UN;
 172         close LOCK;
 173 }
 174
 175 sub quit
 176 {
 177         my $msg = shift;
 178
 179         die $msg if $msg;
 180 }
 181
 182 sub extract_tokens
 183 {
 184         my $pattern = shift;
 185         my %ret;
 186
 187         foreach ( @tasks ) {
 188                 $ret{$2}++ if (/(^|\s)($pattern.*?)(\s|$)/);
 189         }
 190
 191         return keys %ret;
 192 }
 193
 194 sub list_contexts
 195 {
 196         my @contexts = extract_tokens('@');
 197         print join( "\n", @contexts, "" );
 198 }
 199
 200 sub list_groups
 201 {
 202         my @groups = extract_tokens('/');
 203         print join( "\n", @groups, "" );
 204 }
 205