forked from a-schild/cyrus2dovecot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cyrus2dovecot
1846 lines (1580 loc) · 58.1 KB
/
cyrus2dovecot
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env perl
#
# $Id: cyrus2dovecot,v 1.8 2016/06/23 18:15:00 a-schild $
#
# Convert Cyrus folders to Dovecot.
#
# Written by Holger Weiss <holger@ZEDAT.FU-Berlin.DE> at Freie Universitaet
# Berlin, Germany, Zentraleinrichtung fuer Datenverarbeitung (ZEDAT).
#
# Edited by Alex @ Gosign
# Edited by Andre @ Schild.ws
#
# ------------------------------------------------------------------------------
# Copyright (c) 2008 Freie Universitaet Berlin.
# All rights reserved.
#
# This program is free software; you can redistribute it and/or modify it under
# the same terms as Perl itself. See perlartistic(1). 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.
# ------------------------------------------------------------------------------
#
require 5.006; # We need Perl >= 5.6.0 for our open() calls.
use warnings;
use strict;
use Data::Dumper;
use File::Basename;
use Fcntl qw(:seek);
use Getopt::Long qw(:config gnu_getopt auto_help auto_version);
use Sys::Hostname;
#
# Default settings (can be overridden on the command line).
#
# Within pathnames, any occurrence of "%u" will be replaced by the current user
# name, any occurrence of "%<n>u" will be replaced by the <n>'th character of
# that user name, any occurrence of "%h" will be replaced by Cyrus' directory
# "hash" character for that user name (i.e., "%h" is equivalent to "%1u" if the
# first character of the user name is a lowercase letter), and any occurrence of
# "%x" will be replaced by Cyrus' "fulldirhash" character for that user name.
# "%d" will be replaced by the domain part of the username. %U is the user part
# of the username, %P is the userpart of the username with all ^replaced by dots.
# %g is the first character of the domain
#
# See "perldoc cyrus2dovecot" for details.
#
my %DEFAULT = (
dovecot_inbox => '/tmp/dovecot/%u/Maildir',
cyrus_inbox => '/var/spool/imap/user/%u',
cyrus_sub => '/var/imap/user/%h/%u.sub',
cyrus_seen => '/var/imap/user/%h/%u.seen',
cyrus_sieve => undef,
cyrus_quota => undef,
cyrus_quota_format => 1, # Cyrus quota format (1 for legacy).
dovecot_uidlist_format => 3, # Create this dovecot-uidlist format.
dovecot_host => hostname, # The host name for Maildir++ filenames.
dovecot_crlf => 0, # Use CR+LF instead of LF in Dovecot?
default_quota => 0, # Use this quota as a fallback.
cyrus_unixhierarchysep => 0, # replace . in username with ^
dump_meta => 0, # Print the metadata structure?
sieve_only => 0, # When set to 1 only convert sieve scripts
debug => 0, # Print debug output?
quiet => 0, # Suppress the standard output?
edit_foldernames => [] # List of folder name substitutions.
);
#
# Plan of attack: Basically, we convert the folders of a user in two steps.
#
# 1) We call c_read_mailbox() which reads Cyrus' metadata for all folders of the
# user and creates a data structure such as the following. In this example,
# the user has the folder "ac" and the subfolder "ac/dc" next to his INBOX,
# he is subscribed to these folders, and there are two e-mails per folder.
# The user also defined a few IMAP keywords (a.k.a. user flags). Both the
# system flags and user keywords are saved as bitmasks for each e-mail.
#
# $meta->{subscriptions} = [ 'ac', 'ac/dc' ]
# ->{quota} = 2147483648
# ->{sieve} = <text>
# ->{box}->{'INBOX'}->{uidvalidity} = 1107601073
# ->{uidnext} = 3
# ->{nonrecent} = 2 # Last non-recent UID.
# ->{keywords} = [ 'Junk', '$Label1' ]
# ->{mail}->{1}->{internaldate} = 1107601472
# ->{sysflags} = $sysmask
# ->{usrflags} = $usrmask
# {2}->{internaldate} = 1107601543
# ->{sysflags} = $sysmask
# ->{usrflags} = $usrmask
# ->{'ac'} ->{uidvalidity} = 1108639232
# ->{uidnext} = 3
# ->{nonrecent} = 1 # Last non-recent UID.
# ->{keywords} = [ 'Private', 'Work' ]
# ->{mail}->{1}->{internaldate} = 1108639290
# ->{sysflags} = $sysmask
# ->{usrflags} = $usrmask
# {2}->{internaldate} = 1108639299
# ->{sysflags} = $sysmask
# ->{usrflags} = $usrmask
# ->{'ac/dc'}->{uidvalidity} = 1109821442
# ->{uidnext} = 3
# ->{nonrecent} = 1 # Last non-recent UID.
# ->{keywords} = [ 'Rock', 'Pop' ]
# ->{mail}->{1}->{internaldate} = 1109821455
# ->{sysflags} = $sysmask
# ->{usrflags} = $usrmask
# {2}->{internaldate} = 1109821500
# ->{sysflags} = $sysmask
# ->{usrflags} = $usrmask
#
# 2) We call d_write_mailbox() which creates a Dovecot Maildir++ directory
# including all subfolders, writes the metadata, and converts the actual
# e-mails.
#
sub main ();
sub usage ();
sub debug (@);
sub info (@);
sub warning (@);
sub error (@);
sub fatal (@);
sub message ($@);
sub makedir ($);
sub readint ($$);
sub xread ($$$);
sub slurp ($);
sub fixpath ($@);
sub c_fulldirhash ($);
sub c_read_skiplist ($);
sub c_read_mailbox ($$$$$$$$);
sub d_write_mailbox ($$$$);
#
# IMAP flags.
#
use constant FLAG_ANSWERED => (1 << 0); # As stored in Cyrus' index database.
use constant FLAG_FLAGGED => (1 << 1); # As stored in Cyrus' index database.
use constant FLAG_DELETED => (1 << 2); # As stored in Cyrus' index database.
use constant FLAG_DRAFT => (1 << 3); # As stored in Cyrus' index database.
use constant FLAG_SEEN => (1 << 4); # Stored in Cyrus' seen database.
#
# Cyrus skiplist database constants.
#
use constant INORDER => 1;
use constant ADD => 2;
use constant DELETE => 4;
use constant COMMIT => 255;
use constant DUMMY => 257;
use constant HEADER_SIZE => 28;
use constant HEADER_MAGIC_SIZE => 20;
use constant HEADER_MAGIC => "\241\002\213\015skiplist file\0\0\0";
#
# Cyrus mailbox header constants.
#
use constant MAILBOX_HEADER_MAGIC_SIZE => 115;
use constant MAILBOX_HEADER_MAGIC =>
"\241\002\213\015Cyrus mailbox header\n" .
"\"The best thing about this system was that it had lots of goals.\"\n" .
"\t--Jim Morris on Andrew\n"; # Gesundheit!
#
# Miscellaneous constants.
#
use constant UINT32_MAX => 4294967295;
our $VERSION = sprintf('%d.%d (%04d-%02d-%02d)', q$Revision: 1.2 $ =~ /(\d+)/g,
q$Date: 2008/09/24 09:52:33 $ =~ /(\d{4})\/(\d{2})\/(\d{2})/);
my $MYSELF = basename($0);
my ($FOLDERS, $MAILS, $SIZE, $USER, $FROM_STDIN, $QUOTADATA, $EXPUNGED, %CONF);
GetOptions(
\%CONF,
'edit_foldernames|edit-foldernames|E=s@',
'cyrus_inbox|cyrus-inbox|C=s',
'cyrus_quota|cyrus-quota|Q=s',
'cyrus_quota_format|cyrus-quota-format|O=i',
'cyrus_seen|cyrus-seen|S=s',
'cyrus_sieve|cyrus-sieve|I=s',
'cyrus_sub|cyrus-sub|U=s',
'dovecot_host|dovecot-host|H=s',
'dovecot_inbox|dovecot-inbox|D=s',
'default_quota|default-quota|N=s',
'dovecot_uidlist_format|dovecot-uidlist-format|F=i',
'dovecot_crlf|dovecot-crlf|c',
'dump_meta|dump-meta|m',
'cyrus_unixhierarchysep|cyrus-unixhierarchysep|u',
'sieve_only|sieve-only',
'debug|d',
'quiet|q',
'h',
'v'
) or usage;
if ($CONF{h}) {
exec($0, '--help') or die;
}
if ($CONF{v}) {
exec($0, '--version') or die;
}
foreach my $opt (keys %DEFAULT) {
$CONF{$opt} = $DEFAULT{$opt} if not exists($CONF{$opt});
}
fatal('Option dovecot-uidlist-format must be set to: 1 or 3')
if ($CONF{dovecot_uidlist_format} != 1 and
$CONF{dovecot_uidlist_format} != 3);
$SIG{__WARN__} = sub { fatal('Caught exception:', @_) }; # Perl warnings.
$FROM_STDIN = (@ARGV == 0) ? 1 : 0;
$QUOTADATA = c_read_skiplist($CONF{cyrus_quota})
if ($CONF{cyrus_quota} and $CONF{cyrus_quota_format} != 1);
main;
exit 0;
# ----- Generic subroutines. ---------------------------------------------------
#
# Loop over the specified users and convert their e-mails. This is done within
# a subroutine in order to make it callable from error().
#
sub main () {
while (my $user = $FROM_STDIN ? <STDIN> : shift(@ARGV)) {
chomp($user);
my $start = time;
my $meta = {};
my $dovecot_inbox = $CONF{dovecot_inbox};
my $cyrus_inbox = $CONF{cyrus_inbox};
my $cyrus_seen = $CONF{cyrus_seen};
my $cyrus_sub = $CONF{cyrus_sub};
my $cyrus_quota = $CONF{cyrus_quota};
my $cyrus_sieve = $CONF{cyrus_sieve};
my $sieve_only = $CONF{sieve_only};
debug("Converting the e-mail folders of $user.");
if ($sieve_only)
{
if ($cyrus_sieve)
{
debug("Converting only the sieve folders of $user. $sieve_only");
}
else
{
fatal("Requested only sieve conversion, but no cyrus_sieve folder specified");
die;
}
}
# (Re)set "global" variables.
$USER = $user;
$FOLDERS = $MAILS = $SIZE = $EXPUNGED = 0;
# Resolve "%u", "%h", "x", and "%<n>u" within pathnames.
fixpath($user, $dovecot_inbox, $cyrus_inbox, $cyrus_seen,
$cyrus_sub);
fixpath($user, $cyrus_quota)
if ($CONF{cyrus_quota} and $CONF{cyrus_quota_format} == 1);
fixpath($user, $cyrus_sieve)
if ($CONF{cyrus_sieve});
debug('SievePath:',$cyrus_sieve)
if ($CONF{cyrus_sieve});
# Do the actual conversion.
c_read_mailbox($meta, $user, $cyrus_inbox, $cyrus_seen,
$cyrus_sub, $cyrus_quota,$cyrus_sieve, $sieve_only);
debug('Cyrus Inbox:',$cyrus_inbox);
debug('Dovecot Inbox:',$dovecot_inbox);
d_write_mailbox($meta, $cyrus_inbox, $dovecot_inbox, $sieve_only);
# Give some feedback.
print Dumper($meta) if $CONF{dump_meta};
info(sprintf('%u messages in %u folders (%.1f MiB, %u s), %u expunged mails skipped',
$MAILS, $FOLDERS, $SIZE / 1024 / 1024, time - $start, $EXPUNGED))
unless $CONF{quiet};
debug("Done converting the e-mail folders of $user.");
}
}
#
# Print usage information to the standard error output and die.
#
sub usage () {
exec("$0 --help >&2") or die;
}
#
# Print a message to the standard output if we were called with "--debug", do
# nothing otherwise.
#
sub debug (@) {
return unless $CONF{debug};
my @message = @_;
info(@message);
}
#
# Print a message to the standard output.
#
sub info (@) {
my @message = @_;
message(\*STDOUT, @message);
}
#
# Print a message to the standard error output.
#
sub warning (@) {
my @message = @_;
unshift(@message, '(warning)');
message(\*STDERR, @message);
}
#
# Print a message to the standard error output. Then, try to continue with the
# next user (if any). When done, exit >0.
#
sub error (@) {
my @message = @_;
unshift(@message, '(error)');
message(\*STDERR, @message);
main; # Continue with the next user (if any).
exit 1;
}
#
# Print a message to the standard error output and exit >0 immediately.
#
sub fatal (@) {
my @message = @_;
unshift(@message, '(fatal)');
message(\*STDERR, @message);
exit 1;
}
#
# Print a message.
#
sub message ($@) {
my $handle = shift;
my @message = @_;
my $prefix = $MYSELF;
$prefix .= " [$USER]" if defined($USER);
chomp(@message);
print $handle "$prefix: @message\n";
}
#
# Create the specified directory, and recursively create parent directories as
# needed. Die on error.
#
sub makedir ($) {
my $dir = shift;
unless (-d $dir) {
my $parent = dirname($dir);
makedir($parent) if not -d $parent;
mkdir($dir) or error("Cannot create directory $dir: $!");
debug('Created directory:', $dir);
}
}
#
# Read and return a 32-bit integer which is in "network" (big-endian) order.
# Die on error.
#
sub readint ($$) {
my ($file, $handle) = @_;
my $buf = xread($file, $handle, 4);
return unpack('N', $buf);
}
#
# Read the specified number of bytes or die.
#
sub xread ($$$) {
my ($file, $handle, $size) = @_;
my ($buf, $n);
defined($n = read($handle, $buf, $size))
or error("Cannot read $file: $!");
error("Read $n instead of $size bytes from $file.") if $n != $size;
return $buf;
}
#
# Read (the rest of) a file into memory and return the read content.
#
sub slurp ($) {
my $handle = shift;
local $/; # Slurp mode.
return <$handle>;
}
#
# Resolve "%u", "%h", "x", and "%<n>u" within pathnames. Modify the specified
# arguments directly (as opposed to returning the new pathnames).
#
# AP: Added %U (Username only) %d (domainname) %g (first letter of domain)
# AS: Added %P (Username only, all ^replaced by . )
#
sub fixpath ($@) {
my $user = shift;
my @dchar;
my $dhash;
my $domain;
my $duser;
if($user =~ m/@/) #if user contains an @ the user also has a domain part
{
my @userdom = split(/@/, $user);
$duser = $userdom[0];
$domain = $userdom[1];
if($CONF{cyrus_unixhierarchysep})
{
$duser =~ s/\./\^/g; #required for unixhirarchiesep
}
debug("User:", $duser);
debug("Domain:", $domain);
@dchar = split(//, $domain);
$dhash = $dchar[0];
}
my @char = split(//, $user);
my $hash = $char[0];
my $fullhash = c_fulldirhash($user);
if ($hash !~ /^[a-z]$/) {
# This is how Cyrus "hashes" non-[a-z]-characters.
$hash = ($hash =~ /^[A-Z]$/) ? lc($hash) : 'q';
}
for (@_) {
s/%u/$user/g;
s/%h/$hash/g;
s/%x/$fullhash/g;
s/%(\d+)u/$char[$1-1]/g;
if($domain) #user has a domain part, we should use it
{
my $duserDot = $duser;
$duserDot =~ s/\^/\./g;
s/%d/$domain/g;
s/%g/$dhash/g;
s/%U/$duser/g;
s/%P/$duserDot/g;
}
}
}
# ----- Cyrus subroutines. -----------------------------------------------------
sub _c_read_folders ($$$$);
sub _c_read_header ($);
sub _c_read_index ($);
sub _c_read_expunge ($);
sub _c_read_index_format ($);
sub _c_read_old_seen ($);
sub _c_read_legacy_quota ($);
sub _c_read_skiplist_item ($$);
sub _c_parse_seendata ($);
sub _c_seen ($$);
sub _c_make_uid ($$);
#
# Return Cyrus' "fulldirhash" character for the given user name. See also the
# "dir_hash_c" subroutine in tools/rehash.
#
sub c_fulldirhash ($) {
my $user = shift;
my $n = 0;
$n = (($n << 3) ^ ($n >> 5)) ^ ord($_) for split(/ */, $user);
return chr(ord('A') + ($n % 23));
}
#
# Read a "skiplist" database file (or a flat text file) and return a reference
# to a hash containing the records. Die on error.
#
sub c_read_skiplist ($) {
#
# | /*
# | * disk format; all numbers in network byte order
# | *
# | * there's the data file, consisting of the multiple records of "key",
# | * "data", and "skip pointers", where skip pointers are the record number of
# | * the data pointer. [...]
# | */
# |
# | /*
# | header "skiplist file\0\0\0"
# | version (4 bytes)
# | version_minor (4 bytes)
# | maxlevel (4 bytes)
# | curlevel (4 bytes)
# | listsize (4 bytes)
# | in active items
# | log start (4 bytes)
# | offset where log records start, used mainly to tell when to compress
# | last recovery (4 bytes)
# | seconds since unix epoch
# |
# | 1 or more skipnodes, one of:
# |
# | record type (4 bytes) [DUMMY, INORDER, ADD]
# | key size (4 bytes)
# | key string (bit string, rounded to up to 4 byte multiples w/ 0s)
# | data size (4 bytes)
# | data string (bit string, rounded to up to 4 byte multiples w/ 0s)
# | skip pointers (4 bytes each)
# | least to most
# | padding (4 bytes, must be -1)
# |
# | record type (4 bytes) [DELETE]
# | record ptr (4 bytes; record to be deleted)
# |
# | record type (4 bytes) [COMMIT]
# |
# | record type is either
# | DUMMY (first node is of this type)
# | INORDER
# | ADD
# | DELETE
# | COMMIT (commit the previous records)
# | */
# |
# | enum {
# | INORDER = 1,
# | ADD = 2,
# | DELETE = 4,
# | COMMIT = 255,
# | DUMMY = 257
# | };
# |
# | #define HEADER_MAGIC ("\241\002\213\015skiplist file\0\0\0")
# | #define HEADER_MAGIC_SIZE (20)
#
# [ lib/cyrusdb_skiplist.c ]
#
my $file = shift;
my $skiplist = {};
my ($buf, $n);
if (not -e $file) {
#
# The seen or subscription database will not be created until
# the user saw an e-mail or subscribed a folder. So, we just
# return an empty skiplist.
#
debug("$file doesn't exist, I'll pretend it's empty.");
return $skiplist;
}
debug('Reading:', $file);
open(my $handle, '<', $file) or error("Cannot open $file: $!");
# Read and check the header magic.
defined($n = read($handle, $buf, HEADER_MAGIC_SIZE))
or error("Cannot read $file: $!");
if ($n == HEADER_MAGIC_SIZE and $buf eq HEADER_MAGIC) {
# Read the actual header.
$buf = xread($file, $handle, HEADER_SIZE);
my @header = unpack('N7', $buf);
error('Unknown skiplist DB version:', $header[0])
if $header[0] != 1;
debug('Minor skiplist DB version:', $header[1]);
# Read the records.
while ($n = read($handle, $buf, 4)) {
error("Read $n instead of 4 bytes from $file.")
if $n != 4;
my $rectype = unpack('N', $buf);
# Parse the record type.
if ($rectype == COMMIT) {
debug('Record type: COMMIT');
next;
} elsif ($rectype == DELETE) {
debug('Record type: DELETE');
seek($handle, 4, SEEK_CUR)
or error('Cannot seek in:', $file);
next;
} elsif ($rectype == INORDER) {
debug('Record type: INORDER');
} elsif ($rectype == ADD) {
debug('Record type: ADD');
} elsif ($rectype == DUMMY) {
debug('Record type: DUMMY');
} else {
error('Unknown record type:', $rectype);
}
# Read and save the key and the data, if any.
my $key = _c_read_skiplist_item($file, $handle);
my $data = _c_read_skiplist_item($file, $handle);
if (defined($key)) {
$skiplist->{$key} = $data;
$data = '(undef)' if not defined($data);
debug("Saved skiplist record: $key = $data");
}
#
# Skip the "skip pointers" (4 bytes each), terminated by
# 4 bytes of -1 padding.
#
1 while readint($file, $handle) != 0xFFFFFFFF;
}
} else {
# Assume it's a flat text file if the header magic is missing.
debug('Parsing as a flat text file:', $file);
seek($handle, 0, SEEK_SET) or error('Cannot seek in:', $file);
while (<$handle>) {
my ($key, $data) = /(.*)\t(.*)/;
error("Cannot parse $file.")
if not (defined($key) and defined($data));
$skiplist->{$key} = $data;
debug("Saved flat file record: $key = $data");
}
}
close($handle) or error("Cannot close $file: $!");
debug('Done reading:', $file);
return $skiplist;
}
#
# Read all global and folder-specific metadata of a user into the given data
# structure. Die on error.
#
sub c_read_mailbox ($$$$$$$$) {
my ($meta, $user, $rootdir, $seenfile, $subfile, $quotafile, $sievefile, $sieve_only) = @_;
my (%existing, @subscriptions);
if (!$sieve_only)
{
my $seendata = ($seenfile eq 'cyrus.seen') ? undef :
c_read_skiplist($seenfile);
debug('Reading Cyrus metadata.');
_c_read_folders($meta, $rootdir, $rootdir, $seendata);
#
# Cyrus' subscription skiplist keys are in the form "user.<name>.<box>",
# where <name> is the user name and <box> the name of the subscribed
# folder. We only save the latter (or "INBOX" for "user.<name>"). Note
# that the subscription skiplist values are empty. Cyrus doesn't clean
# up subscriptions of folders which no longer exist (as per RFC 3501,
# 6.3.6.). While at it, we check whether a folder exist before adding
# it to the list in order to straighten the subscriptions up.
#
my $domain;
#split $user if it contains an @
if (index($user, '@') != -1) {
debug( "\$user contains '\@'\n");
my @values = split('@', $user);
$user=$values[0];
$domain = $values[1];
}
foreach my $folder (keys %{ $meta->{box} }) {
$folder =~ s/\//./g;
$existing{$folder} = 1;
}
foreach my $folder (keys %{ c_read_skiplist($subfile) }) {
if (defined($domain)){
$folder =~ s/^$domain!user\.$user$/INBOX/;
$folder =~ s/^$domain!user\.[^\.]+\.(.+)$/$1/;
$folder =~ s/\//./g; # Probably not necessary.
}else{
$folder =~ s/^user\.$user$/INBOX/;
$folder =~ s/^user\.[^\.]+\.(.+)$/$1/;
$folder =~ s/\//./g; # Probably not necessary.
}
push(@subscriptions, $folder) if $existing{$folder};
}
$meta->{subscriptions} = \@subscriptions;
debug('Subscribed folders:', @subscriptions);
#
# Save the user's quota limit, either from Cyrus or using the specified
# default quota.
#
if ($quotafile) {
if ($CONF{cyrus_quota_format} == 1) {
$meta->{quota} = _c_read_legacy_quota($quotafile);
} elsif (defined($QUOTADATA->{"user.$user"})) {
$meta->{quota} = $QUOTADATA->{"user.$user"};
$meta->{quota} =~ s/^\d+\s+(\d+)$/$1/;
error('Cannot parse quota:', $QUOTADATA->{"user.$user"})
if $meta->{quota} !~ /^\d+$/;
}
warning('No quota information available.')
if (not $meta->{quota} and not $CONF{default_quota});
}
if ($meta->{quota}) {
$meta->{quota} *= 1024; # Kilobytes to bytes,
} else {
$meta->{quota} = $CONF{default_quota} || 0;
}
debug('Quota:', $meta->{quota});
}
#
# Save sieve rules from the specified sieve file
#
if ($sievefile) {
$meta->{sieve} = _c_read_sieve($sievefile);
warning('No sieve information available.')
if (not $meta->{sieve});
}
debug('Done reading Cyrus metadata.');
}
#
# Read and save the folder-specific metadata for the given mailbox into the
# given data structure. Recurse into subdirectories. Die on error.
#
sub _c_read_folders ($$$$) {
my ($meta, $rootdir, $boxpath, $seendata) = @_;
debug ('Meta: ',$meta);
debug ('Rootdir: ',$rootdir);
debug ('Boxpath: ',$boxpath);
debug ('Seendata: ',$seendata);
my $box = ($boxpath eq $rootdir) ? 'INBOX' : $boxpath;
my ($mailfolder, $index, $expunge, $seen);
#
# Currently, we wouldn't be able to distinguish user.foo.INBOX from
# user.foo. While this could be fixed, a Maildir/.INBOX folder could
# not be accessed via Dovecot, anyway.
#
error('Cannot convert non-INBOX folder named INBOX.')
if $box =~ /^$rootdir\/+INBOX$/;
# Let $box hold the path relative to the root directory (or "INBOX").
# $rootdir = quotemeta($rootdir);
$box =~ s/^\Q$rootdir\E\/+//;
debug('Looking at folder:', $box);
if (-e "$boxpath/cyrus.header" and -e "$boxpath/cyrus.index") {
# Collect this folder's metadata.
my $header = _c_read_header($boxpath);
$index = _c_read_index($boxpath);
$expunge = _c_read_expunge($boxpath);
$header->{folderuid} = _c_make_uid($index->{uidvalidity}, $box)
if not $header->{folderuid};
$seen = defined($seendata) ?
_c_parse_seendata($seendata->{$header->{folderuid}}) :
_c_parse_seendata(_c_read_old_seen($boxpath));
# Autovivify "mail" in case this folder contains no e-mails.
$meta->{box}->{$box}->{mail} = {};
$meta->{box}->{$box}->{nonrecent} = $seen->{nonrecent};
$meta->{box}->{$box}->{uidvalidity} = $index->{uidvalidity};
$meta->{box}->{$box}->{uidnext} = $index->{lastuid} + 1;
$meta->{box}->{$box}->{keywords} =
[ split(/\s+/, $header->{userflags}) ];
debug('The UIDVALIDITY is:', $index->{uidvalidity});
debug('The last message UID is:', $index->{lastuid});
debug('The last non-recent message UID is:', $seen->{nonrecent});
$mailfolder = 1;
} else {
#
# The folder we're in is not in a Cyrus mailbox. However, we
# don't simply return here because this folder might contain
# other folders which might be Cyrus mailboxes (unless we're in
# the INBOX, in which case something is going wrong).
#
error('No Cyrus INBOX at:', $boxpath) if $box eq 'INBOX';
debug("Skipping $boxpath as it's not a Cyrus mailbox.");
$mailfolder = 0;
}
opendir(my $handle, $boxpath) or error("Cannot open $boxpath: $!");
while (my $file = readdir($handle)) {
next if $file =~ /^\.\.?$/;
next if $file =~ /^cyrus\.(?:header|index|expunge|cache|seen|squat)$/;
my $path = "$boxpath/$file";
if (-d $path) {
# Recurse into subfolders.
_c_read_folders($meta, $rootdir, $path, $seendata);
} elsif ($mailfolder and $file =~ /^(\d+)\.$/) {
my $uid = $1;
my $attr;
if ($expunge->{$uid}) {
debug("Message is expunged $uid");
$attr->{expunged} = 1;
}
else
{
if ($index->{$uid}) {
# Save the e-mail's flags and its INTERNALDATE.
debug("Saving attributes of: $box/$file");
$attr->{usrflags} = $index->{$uid}->{usrflags};
$attr->{sysflags} = $index->{$uid}->{sysflags};
$attr->{internaldate} =
$index->{$uid}->{internaldate};
$attr->{expunged} = 0;
} else {
my @statlist = stat($path);
warning("Index record missing for: $box/$file");
error('Cannot stat(2) message file:', $path)
if not defined($statlist[9]);
$attr->{usrflags} = 0;
$attr->{sysflags} = 0;
$attr->{internaldate} = $statlist[9];
}
}
$attr->{sysflags} |= FLAG_SEEN if _c_seen($uid, $seen);
$meta->{box}->{$box}->{mail}->{$uid} = $attr;
} else {
warning("Skipping $box/$file, dunno what it is.");
}
}
closedir($handle) or error("Cannot close $boxpath: $!");
debug('Done with folder:', $box);
}
#
# Read a mailbox header file and return a reference to a hash which holds the
# data. Die on error. See doc/internal/mailbox-format.html for details on the
# format of the mailbox header file.
#
sub _c_read_header ($) {
#
# | This file contains mailbox-wide information that does not change that often.
# | Its format:
# |
# | <Mailbox Header Magic String>
# | <Quota Root>\t<Mailbox Unique ID String>\n
# | <Space-separated list of user flags>\n
# | <Mailbox ACL>\n
#
# [ doc/internal/mailbox-format.html ]
#
my $boxpath = shift;
my $file = "$boxpath/cyrus.header";
my ($header, $buf);
debug('Reading:', $file);
open(my $handle, '<', $file) or error("Cannot open $file: $!");
# Read and check the header magic.
$buf = xread($file, $handle, MAILBOX_HEADER_MAGIC_SIZE);
error("Cannot parse $file: Mailbox header magic incorrect")
if $buf ne MAILBOX_HEADER_MAGIC;
# Slurp the rest of the file into memory and close it.
$buf = slurp($handle);
close($handle) or error("Cannot close $file: $!");
# Guess the header file format and save the data into a hash.
if ($buf =~ /^([^\t\n]*)\t([^\n]+)\n([^\n]*)\n([^\n]*)\n$/) {
$header->{quotaroot} = $1;
$header->{folderuid} = $2;
$header->{userflags} = $3;
$header->{folderacl} = $4;
} elsif ($buf =~ /^([^\n]*)\n([^\n]*)\n([^\n]*)\n$/) {
$header->{quotaroot} = $1;
$header->{folderuid} = 0; # No mailbox UID provided.
$header->{userflags} = $2;
$header->{folderacl} = $3;
} else {
error("Cannot parse $file: One or more fields missing");
}
$header->{userflags} =~ s/\s+$//; # Cyrus adds a trailing space.
debug('Mailbox UID:', $header->{folderuid});
debug('Quota root:', $header->{quotaroot}); # Unused.
debug('Mailbox ACL:', $header->{folderacl}); # Unused.
debug('User-defined keywords:', $header->{userflags});
debug('Done reading:', $file);
return $header;
}
#
# Read a mailbox index file and return a reference to a hash which holds the
# interesting data. Die on error. See doc/internal/mailbox-format.html for
# details on the format of the mailbox index file. See also:
#
# imap/mailbox.h and imap/mailbox.c:mailbox_read_index_header()
#
sub _c_read_index ($) {
my $boxpath = shift;
my $file = "$boxpath/cyrus.index";
return _c_read_index_format($file);
}
sub _c_read_expunge ($) {
my $boxpath = shift;
my $file = "$boxpath/cyrus.expunge";
return _c_read_index_format($file);
}
sub _c_read_index_format ($) {
my $file = shift;
my ($data, $buf, $n);
debug('Reading:', $file);
if (-e "$file")
{
open(my $handle, '<', $file) or error("Cannot open $file: $!");
# Read and save the interesting header fields.
seek($handle, 8, SEEK_SET) or error('Cannot seek in:', $file);
my $version = readint($file, $handle);
my $headersize = readint($file, $handle);
my $recordsize = readint($file, $handle);
debug('Index format version:', $version);
seek($handle, 8, SEEK_CUR) or error('Cannot seek in:', $file);
$data->{lastuid} = readint($file, $handle);
# Skip 4 additional bytes for 64-bit quotas in Cyrus 2.2 and newer.
seek($handle, ($version < 6) ? 8 : 12, SEEK_CUR)
or error('Cannot seek in:', $file);
$data->{uidvalidity} = readint($file, $handle);
#
# As we try to parse future index file formats (i.e., we don't bail out
# if the $version is unknown), we do at least a dumb consistency check:
# Cyrus sets the UIDVALIDITY of a folder to its creation date, so let's
# make sure its value is >= 600000000 (1989-01-05 11:40:00).
#
error("Cannot parse $file: UIDVALIDITY is", $data->{uidvalidity})
if $data->{uidvalidity} < 600000000;
seek($handle, $headersize, SEEK_SET) or error('Cannot seek in:', $file);
# Read and save the interesting fields of all records.
while ($n = read($handle, $buf, 4)) {
error("Read $n instead of 4 bytes from $file.") if $n != 4;
my $uid = unpack('N', $buf);
debug('Reading index record for message UID:', $uid);
# Read, save, and "check" (see above) the INTERNALDATE.
$data->{$uid}->{internaldate} = readint($file, $handle);
error("Cannot parse $file: INTERNALDATE is",
$data->{$uid}->{internaldate})
if $data->{$uid}->{internaldate} < 600000000;
#
# Read and save the system and user flags. Note that the size
# of the user flags bitmask is MAX_USER_FLAGS / 32. At least in
# Cyrus 2.2.12, MAX_USER_FLAGS is 128 by default, so we'll read
# 4 bytes. If this is ever changed, the number of bytes to skip
# at the end of this loop (currently $recordsize - 40) must be
# adjusted accordingly.
#
seek($handle, 24, SEEK_CUR) or error('Cannot seek in:', $file);
$data->{$uid}->{sysflags} = readint($file, $handle);
$data->{$uid}->{usrflags} = readint($file, $handle);
# Skip the rest of the record.
seek($handle, $recordsize - 40, SEEK_CUR)
or error('Cannot seek in:', $file);
}
close($handle) or error("Cannot close $file: $!");
debug('Done reading:', $file);
}
else
{
debug('Dont copy, expunged file:', $file);
}
return $data;
}