Update README with new settings.
[manu/perfect_maildir.git] / perfect_maildir.pl
index 5f5d13e..4667d65 100755 (executable)
@@ -1,39 +1,49 @@
-#!/usr/bin/perl
-
-# "Simple but Perfect" mbox to Maildir converter v0.1
-# by Philip Mak <pmak@aaanime.net>
-
-# Usage: perfect_maildir ~/Maildir < mbox
-
-# Simple  - only converts one mbox (can use script in one-liners)
-# Perfect - message Flags/X-Flags are converted; "^>From ." line is unescaped
-
-# I wrote this script after being unsatisfied with existing mbox to
-# maildir converters. By making it "Simple", code complexity is kept
-# low thus making it easy to program and debug. At the same time,
-# since it only converts one mbox at a time, it is perfect for use in
-# a shell `for'' loop (for example).
-
-# As for being "Perfect", to the best of my knowledge this script does
-# the conversion correctly in all cases; it will translate "Status"
-# and "X-Status" fields into maildir info, and it correctly detects
-# where messages begin and end. (This is only version 0.1 so I may
-# have messed something up though. Please send me feedback!)
-
-# NOTE: The MUA `mutt'' has a bug/feature where in the message index,
-# it claims that all maildir messages have 0 lines unless they have a
-# "Lines:" header set. perfect_maildir does not attempt to add the
-# "Lines:" header; you may want to reconfigure `mutt' to display byte
-# size instead of lines instead by adding the following line to your
-# ~/.muttrc file:
-#
-# set index_format="%4C %Z %{%b %d} %-15.15L (%4c) %s"
+#!/usr/bin/perl -w
+
+# "Simple but Perfect" mbox to Maildir converter v0.3
+# Copyright (C) 2001-2003  Philip Mak <pmak@aaanime.net>
+# 
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# 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; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+
+use strict;
+use Date::Parse qw( str2time );
+
+#### Settings
+# This will be used to set the file time (needed for courier-imap and some others)
+# $datestyle = "date": extract date from the "Date: " header
+# $datestyle = "from": extract date from the "From " mbox header
+my $datestyle = "from";
+
+# Use maildir++ format (append the message size to the filename)
+my $maildirplus = 0;
+####
+
+
+# Get the hostname
+my $hostname = `hostname`;
+chomp ($hostname);
 
 # check for valid arguments
 my ($maildir) = @ARGV;
 if (!$maildir) {
   print STDERR "Usage: perfect_maildir ~/Maildir < mbox\n";
   exit 1;
+} elsif (! -d $maildir) {
+  print STDERR "Cannot open $maildir\n";
+  exit 1;
 }
 
 # check for writable maildir
@@ -48,6 +58,8 @@ unless (-w "$maildir/new") {
 
 my $num = 0;
 my $time = time;
+my $date;
+my $delivered_time;
 
 repeat:
 
@@ -59,6 +71,13 @@ while (my $line = <STDIN>) {
   # detect end of headers
   last if $line eq "\n";
 
+  if ($datestyle eq "from") {
+    # Get date from the "From " line (this should appears here for the first message only)
+    $date = $1 if $line =~ /^From [^ ^\t]+[ \t]+(.{24})/;
+  } elsif ($datestyle eq "date") {
+    # Get date from the "Date: " header
+    $date = $1 if $line =~ /^Date: (.*)$/;
+  }
   # strip "From" line from header
   $headers .= $line unless $line =~ /^From ./;
 
@@ -67,31 +86,44 @@ while (my $line = <STDIN>) {
   $flags .= $1 if $line =~ /^X-Status: ([A-Z]+)/;
   $subject = $1 if $line =~ /^Subject: (.*)$/;
 }
+
 $num++;
 
+if ($datestyle =~ /(from|date)/) {
+  $delivered_time = str2time("$date");
+} else {
+  $delivered_time = $time;
+}
+
 # open output file
 my $file;
 if ($flags =~ /O/) {
-  $file = "$maildir/cur/$time.$num.$ENV{HOSTNAME}";
+  $file = sprintf( "%s%05d%s", "$maildir/cur/$delivered_time.", $num, ".$hostname" );
   my $extra = '';
   $extra .= 'F' if $flags =~ /F/; # flagged
   $extra .= 'R' if $flags =~ /A/; # replied
-  $extra .= 'S' if $flags =~ /R/; # seen
+  $extra .= 'S' if (($flags =~ /R/) || ($flags =~ /O/)); # seen
   $extra .= 'T' if $flags =~ /D/; # trashed
   $file .= ":2,$extra" if $extra;
 } else {
-  $file = "$maildir/new/$time.$num.$ENV{HOSTNAME}";
+  $file = sprintf( "%s%05d%s", "$maildir/new/$delivered_time.", $num, ".$hostname" );
 }
 
-# filter out the "DON'T DELETE THIS MESSAGE -- FOLDER INTERNAL DATA" message
-$file = '/dev/null' if ($num == 1 and $subject eq "DON'T DELETE THIS MESSAGE -- FOLDER
-INTERNAL DATA");
+# filter out the "DON'T DELETE THIS MESSAGE -- FOLDER INTERNAL DATA" message or the message doesn't exists
+if (($num == 1 and $subject eq "DON'T DELETE THIS MESSAGE -- FOLDER INTERNAL DATA") || (!$headers)) {
+       $file = '/dev/null';
+       $num--;
+}
 
 open(FILE, ">$file");
 print FILE "$headers\n";
 while (my $line = <STDIN>) {
-  # detect end of message
-  last if $line =~ /^From ./;
+  if ($datestyle eq "from") {
+    # Get date from the "From " line (this should appears here for the first message only)
+    $date = $1 if $line =~ /^From [^ ^\t]+[ \t]+(.{24})/;
+  }
+    # End of current message 
+  last if ($line =~ /^From ./);
 
   # unescape "From"
   $line =~ s/^>From (.)/From $1/;
@@ -100,6 +132,15 @@ while (my $line = <STDIN>) {
 }
 close(FILE);
 
+utime( $time, $delivered_time, $file ) if ($datestyle =~ /(from|date)/);
+
+if ($maildirplus) {
+       my $size = -s $file;
+       my $mdplusfile = $file;
+       $mdplusfile =~ s/\.$hostname/.$hostname,S=$size/;
+       rename $file,$mdplusfile;
+}
+
 goto repeat unless eof(STDIN);
 
 my $elapsed = time - $time;