source: projects/md2mb/devel/md2mb/bin/md2mb.pl @ 1454

Last change on this file since 1454 was 1454, checked in by ebaudrez, 7 years ago

minor tweaks to command-line option processing

$debug is now an incrementable number. Removed the abbreviation '-old'
for '-oldroot', as Getopt::Long automatically automatically recognizes
such abbreviations.

File size: 9.6 KB
Line 
1#!/usr/bin/perl -w
2
3=head1 NAME
4
5md2mb.pl - Import a maildir kmail environment into a thunderbird one
6
7=cut
8
9use strict;
10use File::Find;
11use File::Copy;
12use File::Basename;
13use File::Path;
14use File::Glob ':glob';
15use Getopt::Long;
16use Pod::Usage;
17use List::Util qw(first);
18
19# settings
20my $cmd = 'formail';
21my $debug = 0;
22my $file = 0; # is the newroot a file (1) or a dir (0) ?
23my $help = 0;
24my $man = 0;
25my $oldroot = first { -d } "$ENV{HOME}/.Mail", "$ENV{HOME}/Mail";
26my @default_profiles = bsd_glob("$ENV{HOME}/.thunderbird/*.default");
27my $profile = shift @default_profiles;
28# if there is more than one default profile (quite unlikely, but you never
29# know), unset $profile again and let the user resolve this
30if (@default_profiles) { undef $profile }
31my $subdir;
32my $touch = 0;
33
34# parse command-line options
35GetOptions(
36    'cmd|c'       => \$cmd,
37    'debug|d+'    => \$debug,
38    'file|f'      => \$file,
39    'help|h'      => \$help,
40    'man|m'       => \$man,
41    'oldroot|o=s' => \$oldroot,
42    'profile|p=s' => \$profile,
43    'subdir|s=s'  => \$subdir,
44    'touch|t'     => \$touch,
45) or pod2usage(2);
46pod2usage(1) if ($help);
47pod2usage(-exitstatus => 0, -verbose => 2) if ($man);
48defined $subdir or pod2usage("Error: -subdir is a mandatory argument\n");
49
50# the new root is constructed from the profile and the chosen subdirectory name
51my $newroot = "$profile/$subdir";
52
53# debug mode overview
54if ($debug) {
55    print <<EOF;
56DEBUG MODE, not doing anything, just printing
57--- current state ---
58debug   = $debug
59cmd     = $cmd
60oldroot = $oldroot
61profile = $profile
62subdir  = $subdir
63newroot = $newroot (constructed)
64--- end ---
65EOF
66}
67
68# some sanity checks before proceeding
69system("$cmd </dev/null >/dev/null 2>/dev/null") == 0 or die <<EOF;
70Cannot run `$cmd' or locate it in your \$PATH!
71
72I need the program `formail' to process your mailboxes. You can provide the
73full path to the formail utility using the `-cmd' command-line switch.
74
75Perhaps `formail' is not installed on your system. Try installing the `formail'
76package using your distribution's package manager. The formail utility might be
77contained in the `procmail' package (e.g., Ubuntu 11.10), so you may need to
78look for the latter instead.
79
80Aborting ...
81EOF
82-d $oldroot or die "cannot find mailbox root `$oldroot'";
83-d $profile or die "cannot find Thunderbird profile directory `$profile'";
84
85# create destination path
86if ($debug) { 
87    print "TARGET DIR: mkdir -p $newroot\n" if ((not -d "$newroot") && (not $file));
88    print "CMD: mkdir -p $newroot\n" if ((not -d "$newroot") && (not $file));
89} else {
90    mkpath("$newroot",0, 0755) if ((not -d "$newroot") && (not $file));
91}
92
93# the main work is done here
94if ($debug) {
95    print "DESCENDING INTO oldroot($oldroot)\n";
96}
97find(\&md2mb,($oldroot));
98
99# now go back again and create empty files corresponding to the `.sbd'
100# directories
101if ($touch) {
102    print "DESCENDING AGAIN INTO oldroot($oldroot)\n" if ($debug);
103    find(sub {
104            return if (! -d);   # consider only directories ...
105            return if (! /\.sbd$/); # ... with the right name
106            s/\.sbd//;      # strip .sbd suffix
107            if ($debug) {
108                print "WOULD CREATE file($_) IF NEEDED\n";
109            } else {
110                open my $fh, '>>', $_ or die "cannot open $_: $!";
111            }
112        }, $newroot);
113}
114
115# rename `inbox' to `Inbox'
116if ((-z "$newroot/Inbox") || (! -e "$newroot/Inbox")) {
117    if ($debug) {
118        print "RENAMING inbox($newroot/inbox) INTO Inbox($newroot/Inbox)\n" if (-e "$newroot/inbox");
119    } else {
120        print "Renaming inbox into Inbox\n";
121        move("$newroot/inbox","$newroot/Inbox") if (-e "$newroot/inbox");
122    }
123}
124
125sub md2mb {
126
127if (-f $File::Find::name) {
128    if (($File::Find::name =~ /\.ids$/) ||
129        ($File::Find::name =~ /\.sorted$/) ||
130        ($File::Find::name =~ /\.index$/)) {
131        print "SKIP FILE: $File::Find::name\n" if ($debug);
132        return;
133    }
134}
135if (-d $File::Find::name) {
136    if (($File::Find::name =~ /\/cur$/) ||
137        ($File::Find::name =~ /\/new$/) ||
138        ($File::Find::name =~ /\/tmp$/)) {
139        print "SKIP DIR: $File::Find::name\n" if ($debug);
140        return;
141    }
142}
143my $destname = $File::Find::name;
144# Target name is under a different root dir
145$destname =~ s|^$oldroot||;
146# Target name is not under a .directory dir but under a .sdb one
147$destname =~ s|\.([^/]+)\.directory/|$1.sbd/|g;
148# Here we create the target dir and target name
149my $outputfile="$newroot/$destname";
150my $cdir = dirname("$outputfile");
151# Handle case where target file name is empty
152$outputfile="$newroot" if ($destname =~ /^\s*$/);
153# When we treat a dir, we will have to handle what it has below
154if (-d $File::Find::name) {
155    if ($debug) { 
156        print "DIR SRC: $File::Find::name\n";
157    }
158    my @files = (bsd_glob("$File::Find::name/cur/*"),bsd_glob("$File::Find::name/new/*"));
159    if (@files) {
160        if ($debug) { 
161            print "DIR ($File::Find::name) DIR TARGET: mkdir -p $cdir\n" if (not -d "$cdir");
162        } else {
163            mkpath("$cdir",0, 0755) if (not -d "$cdir");
164        }
165    }
166    foreach my $file (@files) {
167        next unless -f $file; # skip non-regular files
168        next unless -s $file; # skip empty files
169        next unless -r $file; # skip unreadable files
170        $file =~ s/'/'"'"'/g;  # escape ' (single quote)
171        # NOTE! The output file must not contain single quotes (')!
172        my $run = "cat '$file' | $cmd >> '$outputfile'";
173        if ($debug) { 
174            print "COPYING CONTENT maildir($file) to $outputfile\n";
175            print "CMD: $run\n";
176        } else {
177            print "Copying maildir content from $file to $outputfile\n";
178            system($run) == 0 or warn "cannot run \"$run\".";
179        }
180    }
181}
182if (-f $File::Find::name) {
183    if (($File::Find::name =~ /\/cur\//) ||
184        ($File::Find::name =~ /\/new\//) ||
185        ($File::Find::name =~ /\/tmp\//)) {
186        print "SKIP FILE: $File::Find::name\n" if ($debug);
187        return;
188    }
189    if ($debug) { 
190        print "FILE ($File::Find::name) TARGET DIR: mkdir -p $cdir\n" if (not -d "$cdir");
191        print "CMD: cp $File::Find::name $cdir\n";
192    } else {
193        print "Copying mailbox content from $File::Find::name to $cdir\n";
194        mkpath("$cdir",0, 0755) if (not -d "$cdir");
195        copy($File::Find::name,$cdir);
196    }
197}
198}
199__END__
200
201=head1 SYNOPSIS
202
203md2mb.pl  [options]  -s name
204
205 Options:
206   -cmd     | -c    command to process mail
207   -debug   | -d    debug mode
208   -file    | -f    whether $newroot is a file or a directory
209   -help    | -h    brief help message
210   -man     | -m    full documentation
211   -oldroot | -o    location of the KMail mailboxes
212   -profile | -p    path to the Thunderbird profile to install to
213   -subdir  | -s    subdir that will be created to hold the
214            imported mails
215   -touch   | -t    create empty files corresponding to .sdb dirs
216
217=head1 OPTIONS
218
219=over 4
220
221=item B<-cmd>
222
223Specify the command to process your maildirs. By default uses B<formail> in
224your C<$PATH>, but you can use this option to specify the full path to the
225executable to use instead.
226
227=item B<-debug>
228
229Enter debug mode. This will print what would be done. No commands are executed,
230so this is safe to use when testing.
231
232=item B<-file>
233
234Specifies that $newroot is a file. If this option is omitted, it is assumed
235that $newroot is a directory instead.
236
237=item B<-help>
238
239Print a brief help message and exits.
240
241=item B<-man>
242
243Prints the manual page and exits.
244
245=item B<-oldroot> I<path>
246
247Specify where your B<KMail> mailboxes are to be found. By default assumes a
248folder called F<.Mail> or F<Mail> in your homedir, preferring F<.Mail> if it
249exists.
250
251=item B<-profile> I<path>
252
253Specify the path to the Thunderbird profile. Your imported mails will go inside
254a directory in this profile. By default uses the default profile in the
255F<.thunderbird> directory in your home directory, if it is unique.
256
257=item B<-subdir> I<name>
258
259Specify the subdirectory I<name> that will be created inside the Thunderbird
260profile to hold the imported mails. This option is mandatory; there is no
261default.
262
263=item B<-touch>
264
265Create empty files corresponding to the F<.sbd> dirs created by this script.
266Use this hack if your mails don't show up in Thunderbird.
267
268=back
269
270=head1 EXAMPLES
271
272    # this will fetch all mails from the folder .Mail or Mail in your home
273    # directory, and import them into your default Thunderbird profile, in
274    # a directory called Mail/pop.home.musique-ancienne.org/
275    #
276    # usually, this is all you need to specify:
277
278    perl md2mb.pl -s Mail/pop.home.musique-ancienne.org/
279
280    # on your computer, the mails may end up in
281    # /users/segolene/.thunderbird/qk2f4dl6.default/Mail/pop.home.musique-ancienne.org/
282
283    # if md2mb.pl cannot figure out where your default Thunderbird profile
284    # is, use the following:
285
286    perl md2mb.pl -p ~/.thunderbird/qk2f4dl6.default -s Mail/pop.home.musique-ancienne.org/
287
288=head1 DESCRIPTION
289
290B<md2mb.pl> will import a B<kmail> maildir environment, and transform it into a
291B<thunderbird> one. It relies on B<formail> (or an equivalent utility) being
292available on your system.
293
294By default, B<md2mb.pl> assumes that your B<kmail> mailboxes are stored in a
295folder called F<.Mail> or F<Mail> in your homedir. If this assumption is
296incorrect, you need to specify the correct folder with B<-oldroot>.
297
298The mails will be imported into the Thunderbird profile that is either
299specified with B<-profile> or determined automatically. The script will try to
300determine the default Thunderbird profile automatically. If there is a folder
301that ends in F<.default> in the F<.thunderbird> directory in your home dir, and
302if it is unique, that one will be used.
303
304The mails finally end up in a subdirectory below the profile. You must specify
305the subdirectory on the command line with B<-subdir>, as shown in the examples
306above.
307
308If you have used a structure with subfolders in KMail, mails in subfolders
309might not show up in Thunderbird. Remove the import, and run again with
310B<-touch>.
311
312=head1 AUTHOR
313
314=over 4
315
316=item *
317
318Bruno Cornec, http://brunocornec.wordpress.com
319
320=item *
321
322Edward Baudrez, C<< ebaudrez@cpan.org >>
323
324=back
325
326=head1 LICENSE
327
328Released under the GPLv2 or the Artistic license at your will.
329
330=cut
Note: See TracBrowser for help on using the repository browser.