cyrus-common 2.5.10-3ubuntu1 / usr / lib / cyrus / upgrade / translatesieve

#!/usr/bin/perl
# script to translate sieve scripts to use unixhierarchysep and/or altnamespace
# make sure you run it as the cyrus user
#!/usr/bin/perl
#
# Copyright (c) 1994-2008 Carnegie Mellon University.  All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in
#    the documentation and/or other materials provided with the
#    distribution.
#
# 3. The name "Carnegie Mellon University" must not be used to
#    endorse or promote products derived from this software without
#    prior written permission. For permission or any legal
#    details, please contact
#      Carnegie Mellon University
#      Center for Technology Transfer and Enterprise Creation
#      4615 Forbes Avenue
#      Suite 302
#      Pittsburgh, PA  15213
#      (412) 268-7393, fax: (412) 268-7395
#      innovation@andrew.cmu.edu
#
# 4. Redistributions of any form whatsoever must retain the following
#    acknowledgment:
#    "This product includes software developed by Computing Services
#     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
#
# CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
# THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
# AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
# FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
# AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
# OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

require 5;

$| = 1;

if (($#ARGV > -1) && ("-f" eq $ARGV[0])) {
    $force = 1;
    shift @ARGV;
}
if ((($#ARGV > -1) && ($ARGV[0] eq "-h")) || ($#ARGV > 0)) {
    print "usage: translatesieve [-f] [imapd.conf]\n";
    print "       -f keep going on errors\n";
    exit;
}

sub ouch {
    my $msg = shift;

    if ($force) {
	print "error: $msg\n";
    } else {
	print "fatal error: $msg\n";
	exit 1;
    }
}

sub read_conf {
    my $file = shift;

    open CONF, $file or die "can't open $file";
    while (<CONF>) {
	if (/^#/) { 
	    next; 
	}
	if (/\@include:\s+(.*)$/) {
	    push @configs, $1;
	}
        if (/^sievedir:\s+(.*)$/) {
	    $sievedir = $1;
	    print "you are using $sievedir as your sieve directory.\n";
        }
	if (/^unixhierarchysep:\s*(1|t|yes|on)/) {
	    $unixhierarchysep = 1;
	}
	if (/^altnamespace:\s*(1|t|yes|on)/) {
	    $altnamespace = 1;
	}
	if (/^userprefix:\s*(.*)$/) {
	    $userprefix = $1;
	    print "you are using $userprefix as your other users prefix.\n";
	}
	if (/^sharedprefix:\s*(.*)$/) {
	    $sharedprefix = $1;
	    print "you are using $sharedprefix as your shared prefix.\n";
	}
    }
    close CONF;
}

$imapdconf = shift || "/etc/imapd.conf";

$sievedir = "/usr/sieve";
$unixhierarchysep = 0;
$altnamespace = 0;
$userprefix = "Other Users";
$sharedprefix = "Shared Folders";

push @configs, $imapdconf;

while ($conf = shift @configs) {
    read_conf($conf);
}

unless ($unixhierarchysep || $altnamespace) {
    ouch "you are not using the Unix hierarchy separator or the alternate namespace";
    exit;
}

print "translating sievedir $sievedir... ";
chdir $sievedir or die "couldn't change to $sievedir";
foreach $i ("a".."z") {
    print "$i ";
    if (! chdir $i) {
	ouch "couldn't chdir to $i";
	next;
    }

    # translate the scripts user by user
    opendir (D, ".");
    while ($d = readdir D) {
	next if ($d =~ /^\./s);
	if (! -d $d) {
	    ouch "expected $d to be a directory";
	    next;
	}

	if (! chdir $d) {
	    ouch "couldn't chdir to $d";
	    next;
	}
	
	# translate all of the user's scripts
	opendir DIR, ".";
	while ($file = readdir DIR) {
	    next if (!($file =~ /\.script$/));
	    
	    # print "translating $file... ";
	    if (!open(IN, $file)) {
		ouch "cannot open $file for reading: $!";
		next;
	    }
	    if (!open(OUT, ">.$file")) {
		close(IN);
		ouch "cannot create /.$file: $!";
		next;
	    }

	    $inbox = "[Ii][Nn][Bb][Oo][Xx]";
	    while (<IN>) {
		# Alternate namespace
		if ($altnamespace) {
		    # INBOX
		    if (/\s+fileinto\s+"$inbox"\s*;/) {
			# do nothing
		    }
		    # Personal namespace
		    elsif (/\s+fileinto\s+"($inbox\.[^"]*)"\s*;/) {
			substr($_, index($_, $1), 6) = "";
		    }
		    # Other Users namespace
		    elsif (/\s+fileinto\s+"(user\.[^"]*)"\s*;/) {
			substr($_, index($_, $1), 4) = $userprefix;
		    }
		    # Shared namespace
		    elsif (/\s+fileinto\s+"([^"]*)"\s*;/) {
			substr($_, index($_, $1), 0) = $sharedprefix . ".";
		    }
		}
		# Hierarchy separator
		if ($unixhierarchysep) {
		    if (/\s+fileinto\s+"([^"]*)"\s*;/) {
			substr($_, index($_, $1)) =~ s~\.~/~g;
		    }
		}
		print OUT $_;
	    }
	    close(IN);
	    close(OUT);

	    rename(".$file", "$file")
		or ouch "couldn't move .$file to $file";

	    # print "\n";
	}
	
	closedir DIR;
	chdir "..";
    }
    closedir D;

    # back to "/usr/sieve"
    chdir "..";
}

print "done\n";