calendar-import.plx

#!/usr/bin/perl -w
# calendar-import.plx                                         -*- Perl -*-
# ====================================================================
# NOTE: Overall license of this file is GPLv3-only, due (in part) to Software
# Freedom Law Center copyrights (see below).  Kuhn's personal copyrights are
# licensed GPLv3-or-later.
#
# ====================================================================
# The sub's "safe_read_from_pipe" and read_from_process are:

# Copyright (c) 2000-2004 CollabNet.  All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution.  The terms
# are also available at http://subversion.tigris.org/license-1.html.
# If newer versions of this license are posted there, you may use a
# newer version instead, at your option.
#
# This software consists of voluntary contributions made by many
# individuals.  For exact contribution history, see the revision
# history and logs, available at http://subversion.tigris.org/.


#  Note: bkuhn downloaded the license from
#  http://subversion.tigris.org/license-1.html on 2013-12-29 which said:

# The license of Subversion 1.7 and later is at
# http://svn.apache.org/repos/asf/subversion/trunk/LICENSE.

# The license of Subversion 1.6 and earlier can be found at
# http://svn.apache.org/repos/asf/subversion/tags/1.6.0/www/license-1.html.

# Both license texts are now included, in APACHE-LICENSE and OLD-SVN-LICENSE,
# respectively.
# ====================================================================
#

# Copyright © 2013 Bradley M. Kuhn <bkuhn@ebb.org>
#
# This software's license gives you freedom; you can copy, convey,
# propogate, redistribute and/or modify this program under the terms of
# the GNU  General Public License (GPL) as published by the Free
# Software Foundation (FSF), either version 3 of the License, or (at your
# option) any later version of the GPL published by the FSF.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program in a file in the toplevel directory called
# "GPLv3".  If not, see <http://www.gnu.org/licenses/>.

# ====================================================================
# The functions DoLog, BinarySearchForTZEntry, PrivatizeMergeAndTZIcalFile,
# BuildTZList, MergeLists, PrivacyFilterICalFiles, and FilterEmacsToICal material
# copyrighted and licensed as below:

# Copyright © 2006 Software Freedom Law Center, Inc.
#
# This software gives you freedom; it is licensed to you under version 3
# of the GNU General Public License.
#
# This software is distributed WITHOUT ANY WARRANTY, without even the
# implied warranties of MERCHANTABILITY and FITNESS FOR A PARTICULAR
# PURPOSE.  See the GNU General Public License for further details.
#
# You should have received a copy of the GNU General Public License,
# version 3.  If not, see <http://www.gnu.org/licenses/>


use strict;
use warnings;

use Carp;
use Data::ICal;
use File::Temp qw/:POSIX tempfile/;

my($CONFIG_FILE) = (@ARGV);

if (@ARGV != 1) {
  print STDERR "usage: $0 <CONFIG_FILE>\n";
  exit 1;
}
###############################################################################
my $CALENDAR_LOCK_FILE = "$ENV{HOME}/.emacs-calendar-to-ics-lock";

my $LOCK_CLEANUP_CODE = sub {
  return (unlink($CALENDAR_LOCK_FILE) != 1) ?
    "Failed unlink of $CALENDAR_LOCK_FILE.  Could cause trouble." :
    "";
};
###############################################################################
{
  my %messageHistory;

  sub DoLog ($$$;$) {
    my($type, $user, $message, $cleanupCode) = @_;

    use Date::Manip;
    my $NOW = ParseDate("now");

    my $lastTime = $messageHistory{$message};

    my $sendIt = 0;
    if (not defined $lastTime) {
      $sendIt = 1;
    } else {
      my $err;
      my $sinceLast = DateCalc($lastTime,"+ 10 minutes",\$err);
      $sendIt = 1 if ($NOW gt $sinceLast);
    }
    if ($sendIt) {
      my  $fh = File::Temp->new();
      $fh->unlink_on_destroy( 1 );
      my  $fname = $fh->filename;
      print $fh "Calendar Export Failure: $message\n";
      $fh->close();
      system('/home/bkuhn/bin/myosd', $fname);
      unless (-f "$ENV{HOME}/.silent-running") {
        open(ESPEAK, "-|", "/usr/bin/espeak",  '-p', '45', '-s', '130', '-f', $fname, "--stdout");
        open(PAPLAY, "|-", "/usr/bin/paplay");
        my $data;
        while (read(ESPEAK, $data, 8) == 8) {
          print PAPLAY  $data;
        }
        close PAPLAY; close ESPEAK;
      }
      system('/usr/bin/notify-send', '-u', 'critical', '-t', '300000',
             'Failure', "Calendar export failure: $message");
      $messageHistory{$message} = $NOW;
    }
    my $more;
    $more = &$cleanupCode if defined $cleanupCode and ref $cleanupCode;
    $message .= "  $more" if (defined $more and $more !~ /^\s*$/);
    croak $message if $type eq "die";
    warn $message;
  }
  sub DieLog ($;$) {
    DoLog("die", undef, $_[0], $_[1]);
  }
  sub WarnLog ($;$) {
    DoLog("warn", $_[0], $_[1]);
  }
}
###############################################################################
# Start a child process safely without using /bin/sh.
sub safe_read_from_pipe
{
  unless (@_)
    {
      DieLog("$0: safe_read_from_pipe passed no arguments.");
    }

  my $pid = open(SAFE_READ, '-|');
  unless (defined $pid)
    {
      DieLog("$0: cannot fork: $!");
    }
  unless ($pid)
    {
      open(STDERR, ">&STDOUT")
        or DieLog("$0: cannot dup STDOUT: $!");
      exec(@_)
        or DieLog("$0: cannot exec `@_': $!\n");
    }
  my @output;
  while (<SAFE_READ>)
    {
      s/[\r\n]+$//;
      push(@output, $_);
    }
  close(SAFE_READ);
  my $result = $?;
  my $exit   = $result >> 8;
  my $signal = $result & 127;
  my $cd     = $result & 128 ? "with core dump" : "";
  if ($signal or $cd)
    {
      DieLog("$0: pipe from `@_' failed $cd: exit=$exit signal=$signal\n");
    }
  if (wantarray)
    {
      return ($result, @output);
    }
  else
    {
      return $result;
    }
}
###############################################################################
# Use safe_read_from_pipe to start a child process safely and return
# the output if it succeeded or an error message followed by the output
# if it failed.
sub read_from_process
{
  unless (@_)
    {
      DieLog("$0: read_from_process passed no arguments.");
    }
  my ($status, @output) = &safe_read_from_pipe(@_);
  if ($status)
    {
      return ("$0: `@_' failed with this output:", @output);
    }
  else
    {
      return @output;
    }
}
my $PRINTED_CONKY_HEADER;
###############################################################################
sub  ParseEventAndAddProposed ($$$) {
  my($config, $veventFile, $modString) = @_;

  my $icsImportFile = tmpnam();
  my $newDiaryTempFile = tmpnam();

  my $newCalendar = Data::ICal->new(data => <<END_ICAL
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Emacs//NONSGML icalendar.el//EN
END:VCALENDAR
END_ICAL
);
  my $oldCalendar = Data::ICal->new(filename => $veventFile);
  my $entries = (defined $oldCalendar) ? $oldCalendar->entries : [];
  foreach my $entry (@{$entries}) {
    my $summary = $entry->property("summary");
    if (defined $summary) {
      die("Multiple summary found in $veventFile") unless @{$summary} == 1;
      $summary->[0]->value($modString . ": " .  $summary->[0]->value . " (from $veventFile)");
    }
    $newCalendar->add_entry($entry);
  }
  open(SINGLE_EVENT_ICAL, ">", $icsImportFile) or DieLog("Unable to overwrite $icsImportFile: $!");
  print SINGLE_EVENT_ICAL $newCalendar->as_string;
  close SINGLE_EVENT_ICAL;
  DieLog("Error ($?) while writing $icsImportFile ($?): $!") unless $? == 0;
  undef $newCalendar;

  my($elispFH, $elispFile) = tempfile();
  print $elispFH "(setq-default european-calendar-style t)\n"
    if $config->{calendarStyle} =~  /european/i;
  print $elispFH <<ELISP_END
(setq icalendar-uid-format "emacs-%u-%h-%s")
(icalendar-import-file "$icsImportFile" "$newDiaryTempFile")
ELISP_END
;
  $elispFH->close();
  my @emacsOutput = read_from_process($config->{emacsBinary}, '--no-windows',
                 '--batch', '--no-site-file', '-l', $elispFile);
  DieLog("Emacs process for importing $veventFile and " .
         "$config->{proposedDiary} exited with non-zero exit status of " .
         "$? ($!), and output of:\n    " . join("\n   ", @emacsOutput))
    if ($? != 0);
  my $goodCount =0;
  foreach my $line (@emacsOutput) {
    $goodCount++ if $line =~ /^((Saving.*file|Wrote)\s*$newDiaryTempFile)/;  }
  DieLog("Unexpected Emacs output: " . join("\n   ", @emacsOutput))
    if ($goodCount != 2);

  open(NEW_DIARY, "<", $newDiaryTempFile)
    or DieLog("unable to read temp file: $newDiaryTempFile: $!");
  open(REAL_DIARY, '>>', $config->{proposedDiary})
    or DieLog("unable to append to config->{proposedDiary}: $!");

  while (my $line = <NEW_DIARY>) {
    print "\$hr\n\${font :size=17}Calendar Proposals:\n"
      unless defined $PRINTED_CONKY_HEADER;
    $PRINTED_CONKY_HEADER = 1;
    print "\${font Inconsolata:size=13}$line";
    chomp $line;
    print REAL_DIARY "$line\n" unless defined $config->{__knownLines}{$line};
  }
  close NEW_DIARY;  DieLog("error reading $newDiaryTempFile: $!") unless ($? == 0);
  close REAL_DIARY;  DieLog("error appending to $config->{proposedDiary}: $!") unless ($? == 0);

  WarnLog("unable to remove temporary files, $icsImportFile and $newDiaryTempFile: $!")
          unless unlink($icsImportFile, $newDiaryTempFile) == 2;
}
###############################################################################
sub HandleProposedEvent ($$$) {
  my($config, $operation, $file) = @_;

  if ($operation eq 'A') {
    ParseEventAndAddProposed($config, $file, "ADDITION");
  } elsif ($operation eq 'M') {
    ParseEventAndAddProposed($config, $file, "CHANGE");
  } elsif ($operation eq 'D') {
    chdir $config->{gitDir} or DieLog("Unable to change directory to $config->{gitDir}");
    system($config->{gitBinary}, 'checkout', '-q', $config->{myBranch});
    DieLog("Unable to checkout $config->{myBranch} branch in git") unless ($? == 0);

    ParseEventAndAddProposed($config, $file, "DELETE");

    # Now, reset back to incoming branch, as GenerateDiaryFromNewEvents assumes that.
    chdir $config->{gitDir} or DieLog("Unable to change directory to $config->{gitDir}");
    system($config->{gitBinary}, 'checkout', '-q', $config->{incomingBranch});
    DieLog("Unable to checkout $config->{incomingBranch} branch in git") unless ($? == 0);
  } else {
    DieLog("Invalid operation of $operation for $file");
  }
}
###############################################################################
sub KnownLines ($) {
  my($file) = @_;

  open(DATA, "<", $file) or DieLog("Unable to open $file for reading: $!");

  my %lines;
  while (my $line = <DATA>) { chomp $line; $lines{$line} = $line; }
  return \%lines;
}
###############################################################################
sub GenerateDiaryFromNewEvents ($) {
  my($config)  = @_;

  $config->{__knownLines} = KnownLines($config->{proposedDiary});

  chdir $config->{gitDir} or DieLog("Unable to change directory to $config->{gitDir}");

  system($config->{gitBinary}, 'checkout', '-q', $config->{incomingBranch});
  DieLog("Unable to checkout $config->{incomingBranch} branch in git") unless ($? == 0);
  my @gitDiffSummaryOutput =
    read_from_process($config->{gitBinary}, 'diff-index', $config->{myBranch});

  foreach my $line (@gitDiffSummaryOutput) {
    next unless $line =~ /$ENV{USER}/;   # Ignore lines that aren't for my calendar.
    DieLog("odd line in diff-index output: $line") unless
      $line =~ /(A|D|M)\s+(\S+)$/;
    my($operation, $file) = ($1, $2);
    HandleProposedEvent($config, $operation, $file);
  }
  delete $config->{__knownLines};
}
###############################################################################
sub ReadConfig($) {
  my($configFile) = @_;
  open (CONFIG_FILE, "<", $configFile) or DieLog("unable to read $configFile ($?): $!");

  my %config;

  while (my $line = <CONFIG_FILE>) {
    chomp $line;
    DieLog("Unable to parse $line in config file, $configFile")
      unless $line =~ /^\s*([^:]+)\s*:\s*([^:]+)\s*$/;
    $config{$1} = $2;
  }
  close CONFIG_FILE;  DieLog("Error reading $configFile ($?): $!") if $? != 0;
  return \%config;
}
###############################################################################

system("/usr/bin/lockfile -r 8 $CALENDAR_LOCK_FILE");
DieLog("Failure to acquire calendar lock on $CALENDAR_LOCK_FILE") unless ($? == 0);
my $config = ReadConfig($CONFIG_FILE);

$config->{scrubPrivate} = 0 if not defined $config->{scrubPrivate};
$config->{reportProblems} = $config->{user} if not defined $config->{reportProblems};
$config->{emacsBinary} = "/usr/bin/emacs" if not defined $config->{emacsBinary};
$config->{calendarStyle} = 'plain' if not defined $config->{calendarStyle};
foreach my $bin (qw/emacsBinary gitBinary/) {
  DieLog("$config->{$bin} doesn't appear to be executable for $bin")
    unless defined $config->{$bin} and -x $config->{$bin};
}

DieLog("$CONFIG_FILE doesn't specify a (readable) Git directory via gitDir setting: $!")
  unless defined $config->{gitDir} and -d $config->{gitDir};


GenerateDiaryFromNewEvents($config);
print "\$hr\n" if ($PRINTED_CONKY_HEADER);
&$LOCK_CLEANUP_CODE();
__END__
# Local variables:
# compile-command: "perl -c calendar-import.plx"
# End: