#!/usr/bin/php
<?php
# maildir-check-quotas v1.0 (2004-08-20)
# (c)2004 Tim Jackson (tim@timj.co.uk)
# http://www.timj.co.uk/computing/software/exim/rcpt-time-quota-maildir

# Checks a directory of maildir++ mailboxes for over-quota mailboxes and
# writes the results to a file

# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# 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.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.


# Some basic settings
$VMAIL_DIR = '/home/vmail';
$OUTPUT_FILE = '/etc/exim/maildir_quota_exceeded';
$PID_FILE = '/var/run/maildir-check-quotas.pid';

# Percentage that mailbox is full at which we assume user is overquota
# You should set quota_is_inclusive = false in your Exim config
# unless you set $MAILBOX_FULL_PERCENTAGE quite low, because otherwise
# mailboxes will never be completely filled and will therefore never
# actually exceed the quota.
$MAILBOX_FULL_PERCENTAGE = 100;


#########################################################################
# The code proper
#########################################################################

$VERSION = '1.0';
$VERBOSE = ((in_array('-v',$argv)) ? true : false);

if (in_array('--help',$argv) || in_array('-h',$argv)) {
	print getIntro();
	print "Usage: $argv[0] [-v]\n";
	exit(0); 
}

# pid file interlocking. Could be improved.
if (file_exists($PID_FILE)) {
	print "ERROR: We seem to be running already ($PID_FILE exists). If not, delete $PID_FILE and run again.\n";
	exit(5);
}
$fp = fopen($PID_FILE,'w+');
if (is_resource($fp)) {
	fputs($fp, getmypid());
	fclose($fp);
} else {
	print "ERROR: Could not open pid file $PID_FILE for writing\n";
	exit(5);
}

if ($VERBOSE) print getIntro();

# Get a list of all maildir users
exec("ls -1 $VMAIL_DIR",$Dirs);

$OverQuota = array();
foreach($Dirs as $Dir) {
	if ($VERBOSE) print "Processing $VMAIL_DIR/$Dir...\n";
	$File = "$VMAIL_DIR/$Dir/maildirsize";
	if (file_exists($File)) {
		$Lines = file($File);
		if (preg_match("/^\s*(\d+)S/",$Lines[0],$Matches)) {
			$Quota = $Matches[1];
			if ($VERBOSE) print "\tQuota for $Dir is $Quota bytes (".bytesTomeg($Quota)."MiB)\n";
			$TotalUsed = 0;
			for ($x=1; $x<count($Lines); $x++) {
				preg_match("/^\s*(-?\d+)\s/",$Lines[$x],$Matches);
				$TotalUsed += $Matches[1];
			}
			if ($VERBOSE) print "\t$Dir has used $TotalUsed bytes (".bytesToMeg($TotalUsed)."MiB)\n";
			if ($TotalUsed >= (($MAILBOX_FULL_PERCENTAGE/100)*$Quota)) {
				if ($VERBOSE) print "\t$Dir is overquota\n";
				$OverQuota[] = $Dir;
			}
		} else {
			print "\tERROR: Could not find quota from first line ('$Lines[0]') in $File\n";
		}
	} else {
		if ($VERBOSE) print "\tCould not open $File; assuming no quota\n";
	}
}

$File = "/tmp/".uniqid('quota-');
$fp = fopen($File,'w+');
if (is_resource($fp)) {
	fputs($fp, "# List of maildir users who are over-quota\n# Auto-generated by maildir-check-quotas v$VERSION\n# Generated at ".date('r')."\n");
	foreach ($OverQuota as $User) {
		fputs($fp, $User."\n");
	}
	fclose($fp);
	exec("mv $File $OUTPUT_FILE");
} else {
	print "ERROR: Could not open temp file $File";
	exit(5);
}

unlink($PID_FILE);

function bytesToMeg($Bytes)
{
	return round($Bytes/1048576,2);
}

function getIntro()
{
	global $VERSION;
	return 
		"maildir-check-quotas v$VERSION, copyright (c)2004 Tim Jackson\n".
		"This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n".
		"and you can redistribute it under the terms of the GNU GPL v2+\n\n";
		
}
?>