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