diff --git a/CREDITS b/CREDITS index 016ab50..93b9d0b 100644 --- a/CREDITS +++ b/CREDITS @@ -1,10 +1,13 @@ #!/bin/cat +Reed Sandberg +Added and wrote option --foldersizes + Christoph Nagelreiter Christoph ran imapsync to migrate from Microsoft MCIS to Cyrus IMAP. 16000 mailboxes, 15 GB. -Will he succeed ? +Will he succeed ? YES ! Ivan Zilic Schmidt Made me start the FAQ. diff --git a/ChangeLog b/ChangeLog index 6227712..a5eca12 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,17 +1,20 @@ RCS file: RCS/imapsync,v Working file: imapsync -head: 1.94 +head: 1.95 branch: locks: strict - gilles: 1.94 access list: symbolic names: keyword substitution: kv -total revisions: 94; selected revisions: 94 +total revisions: 95; selected revisions: 95 description: ---------------------------- -revision 1.94 locked by: gilles; +revision 1.95 +date: 2004/07/08 23:31:53; author: gilles; state: Exp; lines: +44 -6 +Applied --foldersizes patch as is from Reed Sandberg +---------------------------- +revision 1.94 date: 2004/06/15 03:42:56; author: gilles; state: Exp; lines: +13 -6 Added time stat ---------------------------- diff --git a/README b/README index 4f885d7..395e3ac 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ NAME imapsync - IMAP sync or copy tool. Synchronize mailboxes between two imap servers. - $Revision: 1.94 $ + $Revision: 1.95 $ INSTALL imapsync works fine under any Unix OS. @@ -44,6 +44,7 @@ SYNOPSIS [--skipsize] [--delete] [--expunge] [--subscribed] [--subscribe] + [--foldersizes] [--dry] [--debug] [--debugimap] [--timeout ] @@ -229,5 +230,5 @@ AUTHOR teaching free open and gratis softwares. Don't hesitate to pay him for that services. - $Id: imapsync,v 1.94 2004/06/15 03:42:56 gilles Exp gilles $ + $Id: imapsync,v 1.95 2004/07/08 23:31:53 gilles Exp $ diff --git a/VERSION b/VERSION index c25d22e..4d51c56 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.94 +1.95 diff --git a/imapsync b/imapsync index 25df767..77536f7 100755 --- a/imapsync +++ b/imapsync @@ -5,7 +5,7 @@ imapsync - IMAP sync or copy tool. Synchronize mailboxes between two imap servers. -$Revision: 1.94 $ +$Revision: 1.95 $ =head1 INSTALL @@ -49,6 +49,7 @@ $Revision: 1.94 $ [--skipsize] [--delete] [--expunge] [--subscribed] [--subscribe] + [--foldersizes] [--dry] [--debug] [--debugimap] [--timeout ] @@ -271,7 +272,7 @@ Gilles LAMIRAL earn his living writing, installing, configuring and teaching free open and gratis softwares. Don't hesitate to pay him for that services. -$Id: imapsync,v 1.94 2004/06/15 03:42:56 gilles Exp gilles $ +$Id: imapsync,v 1.95 2004/07/08 23:31:53 gilles Exp $ =cut @@ -294,7 +295,7 @@ my( $sep1, $sep2, $syncinternaldates, $maxsize, $maxage, - $skipheader, $skipsize, + $skipheader, $skipsize, $foldersizes, $delete, $expunge, $dry, $authmd5, $subscribed, $subscribe, @@ -312,7 +313,7 @@ my( use vars qw ($opt_G); # missing code for this will be option. -$rcs = ' $Id: imapsync,v 1.94 2004/06/15 03:42:56 gilles Exp gilles $ '; +$rcs = ' $Id: imapsync,v 1.95 2004/07/08 23:31:53 gilles Exp $ '; $rcs =~ m/,v (\d+\.\d+)/; $VERSION = ($1) ? $1 : "UNKNOWN"; @@ -349,8 +350,8 @@ $error=0; my $banner = join("", '$RCSfile: imapsync,v $ ', - '$Revision: 1.94 $ ', - '$Date: 2004/06/15 03:42:56 $ ', + '$Revision: 1.95 $ ', + '$Date: 2004/07/08 23:31:53 $ ', "\n", "Mail::IMAPClient version used here is ", $VERSION_IMAPClient, " auth md5 : $md5_supported", @@ -535,6 +536,39 @@ sub get_separator { print "From separator : [$f_sep]\n"; print "To separator : [$t_sep]\n"; +if ($foldersizes) +{ + my $tot = 0; + my $tmess = 0; + print "Calculating sizes...\n"; + foreach my $f_fold (@f_folders) + { + print "From Folder [$f_fold]\n"; + my $stot = 0; + my $smess = 0; + unless ($from->select($f_fold)) { + warn + "From Folder $f_fold : Could not select ", + $from->LastError, "\n"; + $error++; + next; + } + my $szs = $from->fetch_hash("RFC822.SIZE") || (warn("Can't get sizes for $f_fold: ",$from->LastError),$error++,next); + my ($k,$v); + while (($k,$v) = each(%$szs)) + { + $stot += $v->{'RFC822.SIZE'}; + $smess++; + } + print "Size of $f_fold: $stot\n"; + print "Messages in $f_fold: $smess\n"; + $tot += $stot; + $tmess += $smess; + } + print "Total size: $tot\n"; + print "Total messages: $tmess\n"; +} + exit if ($justconnect); # needed for setting flags @@ -789,6 +823,7 @@ sub get_options "syncinternaldates!" => \$syncinternaldates, "maxsize=i" => \$maxsize, "maxage=i" => \$maxage, + "foldersizes" => \$foldersizes, "dry!" => \$dry, "expunge!" => \$expunge, "subscribed!" => \$subscribed, @@ -918,6 +953,9 @@ Several options are mandatory. --subscribe : subscribe to the folders transfered on the "destination" server that are subscribed on the "source" server. +--foldersizes : Discover the size of each "From" folder in bytes + and message counts. Meant to be used with + --justconnect. --debug : debug mode. --debugimap : imap debug mode. --version : print sotfware version. diff --git a/imapsync.sav b/imapsync.sav new file mode 100755 index 0000000..25df767 --- /dev/null +++ b/imapsync.sav @@ -0,0 +1,942 @@ +#!/usr/bin/perl -w + +=head1 NAME + +imapsync - IMAP sync or copy tool. Synchronize mailboxes +between two imap servers. + +$Revision: 1.94 $ + +=head1 INSTALL + + imapsync works fine under any Unix OS. + imapsync works fine under Windows 2000 (at least) and ActiveState's 5.8 Perl + + Get imapsync at + http://www.linux-france.org/prj/imapsync/dist/ + + You'll find a compressed tarball called imapsync-x.xx.tgz + where x.xx is the version number. Untar the tarball where + you want : + + tar xzvf imapsync-x.xx.tgz + + Go into the directory imapsync-x.xx and read the INSTALL + file. + + The freshmeat record is http://freshmeat.net/projects/imapsync/ + +=head1 SYNOPSIS + + imapsync [options] + + imapsync --help + imapsync + + imapsync [--host1 server1] [--port1 ] + [--user1 ] [--passfile1 ] + [--host2 server2] [--port2 ] + [--user2 ] [--passfile2 ] + [--folder --folder ...] + [--include ] [--exclude ] + [--prefix2 ] + [--sep1 ] + [--sep2 ] + [--syncinternaldates] + [--maxsize ] + [--maxage ] + [--skipheader ] + [--skipsize] + [--delete] [--expunge] + [--subscribed] [--subscribe] + [--dry] + [--debug] [--debugimap] + [--timeout ] + [--version] [--help] + +=cut +# comment +=pod + +=head1 DESCRIPTION + +The command imapsync is a tool allowing incremental and recursive +imap transfer from one mailbox to another. + +We sometimes need to transfer mailboxes from one imap server to +another. This is called migration. + +imapsync is the adequate tool because it reduces the amount +of data transfered by not transfering a given message if it +is already on both sides. Same headers, same message size +and the transfert is done only once. All flags are +preserved, unread will stay unread, read will stay read, +deleted will stay deleted. You can stop the transfert at any +time and restart it later, imapsync is adapted to a bad +connection. + +You can decide to delete the messages from the source mailbox +after a successful transfert (it is a good feature when migrating). +In that case, use the --delete option, and run imapsync again +with the --expunge option. + +You can also just synchronize a mailbox A from another mailbox B +in case you just want to keep a "live" copy of B in A. + +=head1 OPTIONS + +Invoke: imapsync --help + +=head1 HISTORY + +I wrote imapsync because an enterprise (basystemes) paid me to install +a new imap server without loosing huge old mailboxes located on a far +away remote imap server accessible by a low bandwith link. The tool +imapcp (written in python) could not help me because I had to verify +every mailbox was well transfered and delete it after a good +transfert. imapsync started its life being a copy_folder.pl patch. +The tool copy_folder.pl comes from the Mail-IMAPClient-2.1.3 perl +module tarball source (in the examples/ directory of the tarball). + +=head1 EXAMPLES + +While working on imapsync parameters please run imapsync in dry mode (no +modification induced) with the --dry option. Nothing bad can be done +this way. + +To synchronize the imap account "buddy" on host "imap.src.fr" to the +imap account "max" on host "imap.dest.fr" (the passwords are located +in too files "/etc/secret1" for "buddy", "/etc/secret2" for "max") : + + imapsync --host1 imap.src.fr --user1 buddy --passfile1 /etc/secret1 \ + --host2 imap.dest.fr --user2 max --passfile2 /etc/secret2 + +Then, you will have buddy's mailbox updated from max's mailbox. + +=head1 SECURITY + +You can use --password1 instead of --passfile1 to give the +password but it is dangerous because any user on your host +can see the password by using the 'ps auxwwww' +command. Using a variable (like $PASSWORD1) is also +dangerous because of the 'ps auxwwwwe' command. So, saving +the password in a well protected file (600 or rw-------) is +the best solution. + +imasync is not protected against sniffers on the network so +the passwords are in plain text. + + +=head1 EXIT STATUS + +imapsync will exit with a 0 status (return code) if everything went good. +Otherwise, it exits with a non-zero status. + +So if you have a buggy internet connection, you can use this loop +in a Bourne shell: + + while ! imapsync ...; do + echo imapsync not complete + done + +=head1 AUTHOR + +Gilles LAMIRAL lamiral@linux-france.org + +=head1 LICENSE + +imapsync is free, gratis and open source software cover by +the GNU General Public License. See the GPL file included in +the distribution or the web site +http://www.gnu.org/licenses/licenses.html + +=head1 BUGS + +No known serious bug. + +Multiple copies: Multiple copies of the emails on the +destination server. Some IMAP servers (Domino for example) +add some headers for each message transfered. The message is +transfered again and again each time you run imapsync. This +is bad of course. The explanation is that imapsync considers +the message is not the same since headers have changed (one +line added) and size too (the header part). You can look at +the headers found by imapsync by using the --debug option +(and search for the message on both part). The way to avoid +this problem is by using options --skipheader and +--skipsize, like this (avoid headers beginning whith X-): + + imapsync ... --skipheader '^X-.*' --skipsize + +Flags : with some IMAP servers the flags are not very well +copied the first time. Run imapsync twice if you want the +flags set correctly. (fixed since 1.28 release but wait for +a time before removing those lines) + +Report any bugs to the author: lamiral@linux-france.org + +=head1 IMAP SERVERS + +Success stories reported (softwares in alphabetic order) : + + - BincImap 1.2.3 + - CommunicatePro server (Redhat 8.0) + - Courier IMAP 1.5.1, 2.2.0, 2.1.1 + - Critical Path (7.0.020) + - Cyrus IMAP 1.5, 1.6, 2.1, 2.1.15, 2.1.16, 2.2.1, Cyrus 2.2.2-BETA + - DBMail 1.2.1 + - Dovecot 0.99.10.4 + - Domino (Notes) 6.5 + - iPlanet Messaging server 4.15, 5.1 + - IMail 7.15 (Ipswitch/Win2003) + - MS Exchange Server 5.5 + - Netscape Mail Server 3.6 (Wintel !) + - SunONE Messaging server 5.2, 6.0 (SUN JES - Java Enterprise System) + - UW-imap servers (imap-2000b) rijkkramer IMAP4rev1 2000.287 + - UW - QMail v2.1 + +Please report to the author any success or bad story with +imapsync and don't forget to mention the IMAP server +software names and version on both sides. This will help +future users. To help the author maintaining this section +report the two lines at the begining of the output if they +are useful to know the softwares. Example: + + From software :* OK louloutte Cyrus IMAP4 v1.5.19 server ready + To software :* OK Courier-IMAP ready + +You can use option --justconnect to get those lines. + +And please rate imapsync at http://freshmeat.net/projects/imapsync/ + +=head1 HUGE MIGRATION + + +Have a special attention on options +--subscribed +--subscribe +--delete +--expunge +--maxage +--maxsize + +If you have many mailboxes to migrate think about a little +shell program. Write a file called file.csv (for example) +containing users and passwords. +The separator used in this example is ';' + +The file.csv file content is : + +user0001;password0001;user0002;password0002 +user0011;password0011;user0012;password0012 +... + +And the shell program is just : + +{ while IFS=';' read u1 p1 u2 p2; do + imapsync --user1 $u1 --password1 $p1 --user2 $u2 --password2 $p2 ... +done ; } < file.csv + +Welcome in shell programming ! + +=head1 Hacking + +Feel free to hack imapsync as the GPL Licence permits it. + +=head1 Links + +Entries for imapsync: + http://www.imap.org/products/showall.php + + +=head1 SIMILAR SOFTWARES + + offlineimap : http://gopher.quux.org:70/devel/offlineimap/ + mailsync : http://mailsync.sourceforge.net/ + imapxfer : http://www.washington.edu/imap/ + part of the imap-utils from UW. + mailutil : replace imapxfer in + part of the imap-utils from UW. + http://www.gsp.com/cgi-bin/man.cgi?topic=mailutil + imaprepl : http://www.bl0rg.net/software/ + http://freshmeat.net/projects/imap-repl/ + imap_migrate: http://freshmeat.net/projects/imapmigration/ + pop2imap : http://www.linux-france.org/prj/pop2imap/ + +Feedback (good or bad) will be always welcome. + +=head1 AUTHOR + +Gilles LAMIRAL earn his living writing, installing, +configuring and teaching free open and gratis +softwares. Don't hesitate to pay him for that services. + +$Id: imapsync,v 1.94 2004/06/15 03:42:56 gilles Exp gilles $ + +=cut + + +++$|; +use strict; +use Getopt::Long; +use Mail::IMAPClient; +use Digest::MD5 qw(md5_base64); +#use Digest::HMAC_MD5; + +eval { require 'usr/include/sysexits.ph' }; + + +my( + $rcs, $debug, $debugimap, $error, + $host1, $host2, $port1, $port2, + $user1, $user2, $password1, $password2, $passfile1, $passfile2, + @folder, $include, $exclude, $prefix2, $regextrans2, + $sep1, $sep2, + $syncinternaldates, + $maxsize, $maxage, + $skipheader, $skipsize, + $delete, $expunge, $dry, + $authmd5, + $subscribed, $subscribe, + $version, $VERSION, $help, + $justconnect, + $mess_size_total_trans, + $mess_size_total_skipped, + $mess_size_total_error, + $mess_trans, $mess_skipped, + $timeout, # whr (ESS/PRW) + $timestart, $timeend, $timediff, + +); + +use vars qw ($opt_G); # missing code for this will be option. + + +$rcs = ' $Id: imapsync,v 1.94 2004/06/15 03:42:56 gilles Exp gilles $ '; +$rcs =~ m/,v (\d+\.\d+)/; +$VERSION = ($1) ? $1 : "UNKNOWN"; + +my $VERSION_IMAPClient = $Mail::IMAPClient::VERSION; + +my $md5_supported = 0; +$md5_supported = md5_supported(); + +$mess_size_total_trans = 0; +$mess_size_total_skipped = 0; +$mess_size_total_error = 0; +$mess_trans = $mess_skipped = 0; + +sub md5_supported { + + + # before 2.2.6 no md5 native + # I know this is ugly, I should write a sort function + if ($VERSION_IMAPClient =~ m/(\d+)\.(\d+)\.(\d+)/) { + $debug and print "VERSION_IMAPClient $1 $2 $3\n"; + my($major,$minor,$sub) = ($1, $2, $3); + return(1) if($major >=3); + return(0) if($major <=1); + return(1) if($minor >=3); + return(0) if($minor <=1); + return(1) if($sub >=6); + return(0) if($sub <=5); + }else{ + return 0; # don't match regex => bad + } +} + +$error=0; + +my $banner = join("", + '$RCSfile: imapsync,v $ ', + '$Revision: 1.94 $ ', + '$Date: 2004/06/15 03:42:56 $ ', + "\n", + "Mail::IMAPClient version used here is ", + $VERSION_IMAPClient, " auth md5 : $md5_supported", + "\n" + ); + +unless(defined(&_SYSEXITS_H)) { + # 64 on my linux box. + eval 'sub EX_USAGE () {64;}' unless defined(&EX_USAGE); +} + +get_options(); +print $banner; + +sub missing_option { + my ($option) = @_; + die "$option option must be used, run $0 --help for help\n"; +} + +$host1 || missing_option("--host1") ; +$port1 = (defined($port1)) ? $port1 : 143; +$user1 || missing_option("--user1"); +$password1 || $passfile1 || missing_option("--passfile1 or --password1"); +$password1 = (defined($passfile1)) ? firstline ($passfile1) : $password1; + +$host2 || missing_option("--host2") ; +$port2 = (defined($port2)) ? $port2 : 143; +$user2 || missing_option("--user2"); +$password2 || $passfile2 || missing_option("--passfile2 or --password2"); +$password2 = (defined($passfile2)) ? firstline ($passfile2) : $password2; + +$authmd5 = (defined($authmd5)) ? $authmd5 : 1; + +print "From imap server [$host1] port [$port1] user [$user1]\n"; +print "To imap server [$host2] port [$port2] user [$user2]\n"; + +my $from = (); +my $to = (); + +my $authmech = "CRAM-MD5"; + +unless ($md5_supported) { + print "Auth $authmech not supported by IMAPClient $VERSION_IMAPClient\n"; + }else{ + print "Auth $authmech supported by IMAPClient $VERSION_IMAPClient\n"; + } + +$timestart = time(); + +$debugimap and print "From connection\n"; +$from = login_imap($host1, $port1, $user1, $password1, $debugimap, $timeout); + +$debugimap and print "To connection\n"; +$to = login_imap($host2, $port2, $user2, $password2, $debugimap, $timeout); + +sub login_imap { + my($host, $port, $user, $password, + $debugimap, $timeout, $authmech) = @_; + my $imap = Mail::IMAPClient->new(); + $imap->Server($host); + $imap->Port($port); + $imap->Fast_io(1); + $imap->Uid(1); + $imap->Peek(1); + $imap->Debug($debugimap); + $imap->connect() + or die "Can not open imap connection on [$host] with user [$user] : $@\n"; + if ($timeout) # whr (ESS/PRW) + { + $imap->Timeout($timeout); + print "Setting imap timeout to $timeout\n"; + } + + $imap->User($user); + $imap->Password($password); + md5auth($imap); + $imap->login() or die "Error login : [$host] with user [$user] : $@"; + return($imap); +} + + +sub md5auth() { + my ($imap) = @_; + unless ($md5_supported) { + return; + } + unless ($authmd5) { + print "$authmech not wanted by you\n"; + return; + } + if ($imap->has_capability($authmech) + or $imap->has_capability("AUTH=$authmech")) { + print "Server [", $imap->Server, + "] has capability $authmech\n"; + }else{ + print "Server [", $imap->Server, + "] has NOT capability $authmech\n"; + return; + } + #print "EE", $imap->Authmechanism(), "\n"; + if ($imap->Authmechanism($authmech)) { + print "Using $authmech authentification\n"; + #$imap->Authmechanism(undef); + #print "EE", $imap->Authmechanism(), "\n"; + }else{ + $imap->Authmechanism(undef); + print "Can NOT use $authmech authentification, using plain\n"; + + } + return; +} + + +print "From software : ", ($from->Report())[0]; +print "To software : ", ($to->Report())[0]; + +print "From capability : ", join(" ", $from->capability()), "\n"; +print "To capability : ", join(" ", $to->capability()), "\n"; + +die unless $from->IsAuthenticated(); +die unless $to->IsAuthenticated(); + +my (@f_folders, @t_folders, %fs_folders); + +# Make a hash of subscribed folders in source server. +map { $fs_folders{$_}=1 } $from->subscribed(); + + + + +if (scalar(@folder)) { + # folders given by option --folder + @f_folders = @folder; +}elsif ($subscribed) { + # option --subscribed + @f_folders = sort keys (%fs_folders); +}else { + # no option, all folders + @f_folders = sort $from->folders(); + # consider (optional) includes and excludes + if ($include) { + @f_folders = grep /$include/,@f_folders; + print "Only including folders matching pattern '$include'\n"; + } + if ($exclude) { + @f_folders = grep !/$exclude/,@f_folders; + print "Excluding folders matching pattern '$exclude'\n"; + } +} + +my($f_sep,$t_sep); +# what are the private folders separators for each server ? + + +$debug and print "Getting separators\n"; +$f_sep = get_separator($from, $sep1, "--sep1"); +$t_sep = get_separator($to, $sep2, "--sep2"); + +sub get_separator { + my($imap, $sep_in, $sep_opt) = @_; + my($sep_out); + $debug and print "Calling namespace capability\n"; + if ($imap->has_capability("namespace")) { + # Less complicated call. Must be tested + # before uncommenting definitively. + $sep_out = $imap->separator(); + #$sep_out = $imap->namespace()->[0][0][1]; + + }elsif ($sep_in) { + $sep_out = $sep_in; + }else{ + print + "No NAMESPACE capability in imap server ", + $imap->Server(),"\n", + "Give the separator caracter with the $sep_opt option\n"; + exit(1); + } + return($sep_out); +} + + +print "From separator : [$f_sep]\n"; +print "To separator : [$t_sep]\n"; + +exit if ($justconnect); + +# needed for setting flags +# my $tohasuidplus = $to->has_capability("UIDPLUS"); + + +@t_folders = sort @{$to->folders()}; +print + "From folders : ", map("[$_] ",@f_folders),"\n", + "To folders : ", map("[$_] ",@t_folders),"\n"; + +print + "From subscribed folders : ", map("[$_] ", sort keys(%fs_folders)), "\n"; + +sub separator_invert { + # The separator we hope we'll never encounter + my $o_sep="\000"; + + my($f_fold, $f_sep, $t_sep) = @_; + + my $t_fold = $f_fold; + $t_fold =~ s@\Q$t_sep@$o_sep@g; + $t_fold =~ s@\Q$f_sep@$t_sep@g; + $t_fold =~ s@\Q$o_sep@$f_sep@g; + return($t_fold); +} + +FOLDER: foreach my $f_fold (@f_folders) { + my $t_fold; + print "From Folder [$f_fold]\n"; + + $t_fold = separator_invert($f_fold,$f_sep, $t_sep); + if ($regextrans2) { + $debug and print "eval \$t_fold =~ $regextrans2\n"; + eval("\$t_fold =~ $regextrans2"); + } + $t_fold = $prefix2 . $t_fold if ($prefix2); + print "To Folder [$t_fold]\n"; + + unless ($from->select($f_fold)) { + warn + "From Folder $f_fold : Could not select ", + $from->LastError, "\n"; + $error++; + next FOLDER; + } + + unless ($to->exists($t_fold) or $to->select($t_fold)) { + print "To Folder $t_fold does not exist\n"; + print "Creating folder [$t_fold]\n"; + unless ($dry){ + unless ($to->create($t_fold)){ + warn "Couldn't create [$t_fold]", + $to->LastError,"\n"; + $error++; + next FOLDER; + } + }else{ + next FOLDER; + } + } + + unless ($to->select($t_fold)) { + warn + "To Folder $t_fold : Could not select ", + $to->LastError, "\n"; + $error++; + next FOLDER; + } + + if ($expunge){ + print "Expunging $f_fold and $t_fold\n"; + unless($dry) { $from->expunge() }; + #unless($dry) { $to->expunge() }; + } + + if ($subscribe and exists $fs_folders{$f_fold}) { + print "Subscribing to folder $t_fold on destination server\n"; + unless($dry) { $to->subscribe($t_fold) }; + } + + my @f_msgs = $maxage ? $from->since(time - 86400 * $maxage) : $from->search("ALL"); + $debug and print "LIST FROM : @f_msgs\n"; + # internal dates on "TO" are after the ones on "FROM" + # normally... + my @t_msgs = $maxage ? $to->since(time - 86400 * $maxage) : $to->search("ALL"); + $debug and print "LIST TO : @t_msgs\n"; + + my %f_hash = (); + my %t_hash = (); + + $debug and print "++++ From Parse ++++\n"; + foreach my $m (@f_msgs) { + parse_header_msg($m, $from, "F", \%f_hash); + } + + $debug and print "++++ To Parse ++++\n"; + foreach my $m (@t_msgs) { + parse_header_msg($m, $to, "T", \%t_hash); + } + $debug and print "++++ Verifying ++++\n"; + # messages in "from" that are not good in "to" + + MESS: foreach my $m_id (keys(%f_hash)) { + my $f_size = $f_hash{$m_id}{'s'}; + my $f_msg = $f_hash{$m_id}{'m'}; + if (defined $maxsize and $f_size > $maxsize) { + print "+ Skipping msg #$f_msg:$f_size in folder $f_fold (exceeds maxsize limit $maxsize bytes)\n"; + $mess_size_total_skipped += $f_msg; + next MESS; + } + $debug and print "+ key $m_id #$f_msg\n"; + unless (exists($t_hash{$m_id})) { + print "+ NO msg #$f_msg [$m_id] in $t_fold\n"; + # copy + print "+ Copying msg #$f_msg:$f_size to folder $t_fold\n"; + unless ($dry) { + my $string = $from->message_string($f_msg); + $debug and print "F message content begin next line\n", + $string, + "F message content end previous line\n"; + my $d = $from->internaldate($f_msg); + $d = "\"$d\""; + $debug and print "internal date from 1: [$d]\n"; + $syncinternaldates or $d = ""; + my $flags_f = join(" ", @{$from->flags($f_msg)}); + # RFC 2060 : This flag can not be altered by the client + $flags_f =~ s@\\Recent@@g; + + my $new_id; + print "flags from : [$flags_f][$d]\n"; + unless($new_id = $to->append_string($t_fold,$string, $flags_f, $d)){ + warn "Couldn't append msg #$f_msg (Subject:[".$from->subject($f_msg)."]) to folder $t_fold: ", + $to->LastError, "\n"; + $error++; + $mess_size_total_error += $f_size; + next MESS; + + }else{ + # good + # $new_id is an id if the IMAP server has the + # UIDPLUS capability else just a ref + print "Copied msg id [$f_msg] to folder $t_fold msg id [$new_id]\n"; + $mess_size_total_trans += $f_size; + $mess_trans += 1; + } + } + next MESS; + }else{ + $debug and print "Message id [$m_id] found in t:$t_fold\n"; + $mess_size_total_skipped += $f_size; + $mess_skipped += 1; + } + + #$debug and print "MESSAGE $m_id\n"; + my $t_size = $t_hash{$m_id}{'s'}; + my $t_msg = $t_hash{$m_id}{'m'}; + + $debug and print "Setting flags\n"; + my (@flags_f,@flags_t); + @flags_f = @{$from->flags($f_msg)}; + # No flag \Recent here, no ? + + $to->store($t_msg, + "+FLAGS (" . join(" ", @flags_f) . ")" + ); + @flags_t = @{$to->flags($t_msg)}; + $debug and print + "flags from : @flags_f\n", + "flags to : @flags_t\n"; + $debug and print "Looking dates\n"; + my $d_f = $from->internaldate($f_msg); + my $d_t = $to->internaldate($t_msg); + $debug and print + "idate from : $d_f\n", + "idate to : $d_t\n"; + #unless ($d_f eq $d_t) { + # print "!!! Dates differ !!!\n"; + #} + unless ($f_size == $t_size) { + # Bad size + print + "Message $m_id SZ_BAD f:$f_msg:$f_size t:$t_msg:$t_size\n"; + # delete in to and recopy ? + # NO recopy CODE HERE. to be written if needed. + $error++; + if ($opt_G){ + print "Deleting msg f:#$t_msg in folder $t_fold\n"; + $to->delete_message($t_msg); + } + }else { + # Good + $debug and print + "Message $m_id SZ_GOOD f:$f_msg:$f_size t:$t_msg:$t_size\n"; + if($delete) { + print "Deleting msg #$f_msg in folder $f_fold\n"; + $from->delete_message($f_msg); + $from->expunge() if ($expunge); + } + } + } +} + +$timeend = time(); + +$timediff = $timeend - $timestart; + +stats(); + +exit(1) if($error); + +sub stats { + print "++++ Statistics ++++\n"; + print "Time : $timediff sec\n"; + print "Messages transfered : $mess_trans\n"; + print "Messages skipped : $mess_skipped\n"; + print "Total bytes transfered : $mess_size_total_trans\n"; + print "Total bytes skipped : $mess_size_total_skipped\n"; + print "Total bytes error : $mess_size_total_error\n"; + print "Detected $error errors\n"; + print "Please, rate imapsync at http://freshmeat.net/projects/imapsync/\n"; + + +} + + +sub get_options +{ + my $numopt = scalar(@ARGV); + my $opt_ret = GetOptions( + "debug!" => \$debug, + "debugimap!" => \$debugimap, + "host1=s" => \$host1, + "host2=s" => \$host2, + "port1=i" => \$port1, + "port2=i" => \$port2, + "user1=s" => \$user1, + "user2=s" => \$user2, + "password1=s" => \$password1, + "password2=s" => \$password2, + "passfile1=s" => \$passfile1, + "passfile2=s" => \$passfile2, + "authmd5!" => \$authmd5, + "sep1=s" => \$sep1, + "sep2=s" => \$sep2, + "folder=s" => \@folder, + "include=s" => \$include, + "exclude=s" => \$exclude, + "prefix2=s" => \$prefix2, + "regextrans2=s" => \$regextrans2, + "delete!" => \$delete, + "syncinternaldates!" => \$syncinternaldates, + "maxsize=i" => \$maxsize, + "maxage=i" => \$maxage, + "dry!" => \$dry, + "expunge!" => \$expunge, + "subscribed!" => \$subscribed, + "subscribe!" => \$subscribe, + "justconnect!"=> \$justconnect, + "version" => \$version, + "help" => \$help, + "timeout=i" => \$timeout, + "skipheader=s" => \$skipheader, + "skipsize!" => \$skipsize, + ); + + $debug and print "get options: [$opt_ret]\n"; + + # just the version + print "$VERSION\n" and exit if ($version) ; + + # exit with --help option or no option at all + usage() and exit if ($help or ! $numopt) ; + + # don't go on if options are not all known. + exit(EX_USAGE()) unless ($opt_ret) ; + + +} + + +sub parse_header_msg { + + my ($m, $imap, $s, $s_hash) = @_; + $debug and print "-" x 50, "\nMSG $m\n"; + my $head = $imap->parse_headers($m,"ALL"); + my $headstr; + $debug and print "Head NUM:", scalar(keys(%$head)), "\n"; + # no header -> return + return unless(scalar(keys(%$head))); + foreach my $h (sort keys(%$head)){ + foreach my $val (sort @{$head->{$h}}) { + # no 8-bit data in headers ! + $val =~ s/[\x80-\xff]/X/g; + # remove the first blanks (dbmail bug ?) + $val =~ s/^\s+//; + # show stuff in debug mode + $debug and print "${s}H $h:", $val, "\n"; + if ($skipheader and $h =~ m/$skipheader/) { + $debug and print "Skipping header $h\n"; + next; + } + $headstr .= "$h:". $val; + } + } + my $m_md5 = md5_base64($headstr); + my $size = $imap->size($m); + $debug and print "$s msg $m:$m_md5:$size\n"; + $size = 0 if ($skipsize); + $s_hash->{"$m_md5:$size"}{'5'} = "$m_md5:$size"; + $s_hash->{"$m_md5:$size"}{'s'} = $size; + $s_hash->{"$m_md5:$size"}{'m'} = $m; +} + +sub firstline { + # extract the first line of a file (without \n) + + my($file) = @_; + my $line = ""; + + open FILE, $file or die("$! $file"); + chomp($line = ); + close FILE; + $line = ($line) ? $line : "!EMPTY! $file"; + return $line; +} + +sub usage { + print < : "from" imap server. Mandatory. +--port1 : port to connect. Default is 143. +--user1 : user to login. Mandatory. +--password1 : password for the user1. Dangerous, use --passfile1 +--passfile1 : password file for the user1. Contains the password. +--host2 : "destination" imap server. Mandatory. +--port2 : port to connect. Default is 143. +--user2 : user to login. Mandatory. +--password2 : password for the user2. Dangerous, use --passfile2 +--passfile2 : password file for the user2. Contains the password. +--noauthmd5 : don't use MD5 authentification +--folder : sync only this folder. +--folder : and this one. +--folder : and this one, etc. +--include : only sync folders matching this regular expression + (only effective if neither --folder nor --subscribed + is specified) +--exclude : skip folders matching this regular expression + (only effective if neither --folder nor --subscribed + is specified) +--prefix2 : add prefix to all destination folders + (usually INBOX. for cyrus imap servers) +--regextrans2 : Apply the whole regex to each destination folders. +--sep1 : separator in case namespace is not supported. +--sep2 : idem. +--delete : delete messages in source imap server after + a successful transfert. Useful in case you + want to migrate from one server to another one. + With imap, delete tags messages as deleted, they + are not really deleted. See expunge. +--expunge : expunge messages on source account. + expunge really deletes messages marked deleted. + expunge is made at the begining on the + source server only. newly transfered messages + are expunged if option --expunge is given. + no expunge is done on destination account but + it will change in future releases. +--syncinternaldates : set the internal dates on host2 same as host1 +--maxsize : skip messages larger than bytes +--maxage : skip messages older than days. + final stats (skipped) don't count older messages +--skipheader : Don't take into account header keyword + matching ex: --skipheader 'X.*' +--skipsize : Don't take message size into account. +--dry : do nothing, just print what would be done. +--subscribed : transfer only subscribed folders. +--subscribe : subscribe to the folders transfered on the + "destination" server that are subscribed + on the "source" server. +--debug : debug mode. +--debugimap : imap debug mode. +--version : print sotfware version. +--justconnect : just connect to both servers and print useful + information. +--timeout : imap connect timeout. +--help : print this. + +Example: to synchronise imap account "foo" on "imap.truc.org" + to imap account "bar" on "imap.trac.org" + +$0 \\ + --host1 imap.troc.org --user1 foo --passfile1 /etc/secret1 \\ + --host2 imap.trac.org --user2 bar --passfile2 /etc/secret2 + + + Mail::IMAPClient version is $Mail::IMAPClient::VERSION +$rcs + imapsync copyleft is the GNU General Public License. + See http://www.gnu.org/copyleft/gpl.html +EOF +} diff --git a/patches/imapsync-1.94-foldersizes.diff b/patches/imapsync-1.94-foldersizes.diff new file mode 100644 index 0000000..385d374 --- /dev/null +++ b/patches/imapsync-1.94-foldersizes.diff @@ -0,0 +1,77 @@ +--- imapsync Mon Jun 14 20:43:03 2004 ++++ imapsync-mod Sun Jun 27 22:57:55 2004 +@@ -49,6 +49,7 @@ + [--skipsize] + [--delete] [--expunge] + [--subscribed] [--subscribe] ++ [--foldersizes] + [--dry] + [--debug] [--debugimap] + [--timeout ] +@@ -294,7 +295,7 @@ + $sep1, $sep2, + $syncinternaldates, + $maxsize, $maxage, +- $skipheader, $skipsize, ++ $skipheader, $skipsize, $foldersizes, + $delete, $expunge, $dry, + $authmd5, + $subscribed, $subscribe, +@@ -535,6 +536,39 @@ + print "From separator : [$f_sep]\n"; + print "To separator : [$t_sep]\n"; + ++if ($foldersizes) ++{ ++ my $tot = 0; ++ my $tmess = 0; ++ print "Calculating sizes...\n"; ++ foreach my $f_fold (@f_folders) ++ { ++ print "From Folder [$f_fold]\n"; ++ my $stot = 0; ++ my $smess = 0; ++ unless ($from->select($f_fold)) { ++ warn ++ "From Folder $f_fold : Could not select ", ++ $from->LastError, "\n"; ++ $error++; ++ next; ++ } ++ my $szs = $from->fetch_hash("RFC822.SIZE") || (warn("Can't get sizes for $f_fold: ",$from->LastError),$error++,next); ++ my ($k,$v); ++ while (($k,$v) = each(%$szs)) ++ { ++ $stot += $v->{'RFC822.SIZE'}; ++ $smess++; ++ } ++ print "Size of $f_fold: $stot\n"; ++ print "Messages in $f_fold: $smess\n"; ++ $tot += $stot; ++ $tmess += $smess; ++ } ++ print "Total size: $tot\n"; ++ print "Total messages: $tmess\n"; ++} ++ + exit if ($justconnect); + + # needed for setting flags +@@ -789,6 +823,7 @@ + "syncinternaldates!" => \$syncinternaldates, + "maxsize=i" => \$maxsize, + "maxage=i" => \$maxage, ++ "foldersizes" => \$foldersizes, + "dry!" => \$dry, + "expunge!" => \$expunge, + "subscribed!" => \$subscribed, +@@ -918,6 +953,9 @@ + --subscribe : subscribe to the folders transfered on the + "destination" server that are subscribed + on the "source" server. ++--foldersizes : Discover the size of each "From" folder in bytes ++ and message counts. Meant to be used with ++ --justconnect. + --debug : debug mode. + --debugimap : imap debug mode. + --version : print sotfware version. diff --git a/tests.sh b/tests.sh index 05f1ae2..318c7c7 100644 --- a/tests.sh +++ b/tests.sh @@ -1,8 +1,11 @@ #!/bin/sh -# $Id: tests.sh,v 1.19 2004/06/15 03:42:16 gilles Exp gilles $ +# $Id: tests.sh,v 1.20 2004/07/08 23:32:36 gilles Exp $ # $Log: tests.sh,v $ +# Revision 1.20 2004/07/08 23:32:36 gilles +# Added foldersizes() test +# # Revision 1.19 2004/06/15 03:42:16 gilles # success on bigtransfer() # @@ -426,6 +429,23 @@ bad_host() } +foldersizes() +{ + if test X`hostname` = X"plume"; then + echo3 Here is plume + ./imapsync \ + --host2 plume --user2 tata@est.belle \ + --passfile2 /var/tmp/secret.tata \ + --host1 loul --user1 tata \ + --passfile1 /var/tmp/secret.tata \ + --justconnect --foldersizes + else + : + fi + +} + + big_transfert() { date1=`date` @@ -468,7 +488,8 @@ test $# -eq 0 && run_tests \ lp_noauthmd5 \ lp_skipsize \ lp_skipheader \ - lp_regextrans2 + lp_regextrans2 \ + foldersizes # selective tests