bogofilter.pl

#!/usr/bin/perl
#
# RRD script to display bogofilter spam statistics
#
# Copyright (C) 2007, 2008, 2011, 2015-2017  Christian Garbs <mitch@cgarbs.de>
# Licensed under GNU GPL v3 or later.
#
# This file is part of my rrd scripts (https://github.com/mmitch/rrd).
#
# 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 3 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, see <http://www.gnu.org/licenses/>.
#

#
# This script should be run every 5 minutes.
#
# *ADDITIONALLY* data aquisition is done externally for every received mail (eg. through procmailrc)
# HAM:
#    rrdtool update $datafile N:1:0:0
# UNSURE:
#    rrdtool update $datafile N:0:1:0
# SPAM:
#    rrdtool update $datafile N:0:0:1
#
# see bogofilter-procmailrc.sh for an example.
#
use strict;
use warnings;
use RRDs;

# parse configuration file
my %conf;
eval(`cat ~/.rrd-conf.pl`);
die $@ if $@;

# set variables
my $datafile = "$conf{DBPATH}/bogofilter.rrd";
my $picbase  = "$conf{OUTPATH}/bogofilter-";

# global error variable
my $ERR;

# get graph minimum time ($DETAIL_TIME in rrd_runall.sh)
my $MINTIME = 1;
if (defined $ARGV[0])
{
    $MINTIME = shift @ARGV;
}

# whoami?
my $hostname = `/bin/hostname`;
chomp $hostname;

# generate database if absent
if ( ! -e $datafile ) {
    RRDs::create($datafile,
		 "--step=60",
		 "DS:ham:ABSOLUTE:600:0:U",
		 "DS:unsure:ABSOLUTE:600:0:U",
		 "DS:spam:ABSOLUTE:600:0:U",
	         "RRA:AVERAGE:0.5:1:120",
		 "RRA:AVERAGE:0.5:5:600",
		 "RRA:AVERAGE:0.5:30:700",
		 "RRA:AVERAGE:0.5:120:775",
		 "RRA:AVERAGE:0.5:1440:797",
		 );
      $ERR=RRDs::error;
      die "ERROR while creating $datafile: $ERR\n" if $ERR;
      print "created $datafile\n";
  }

# data aquisition is done externally, see above
# but we need a value every 5 minutes or we only get NaN in aggretations
RRDs::update($datafile,
             'N:0:0:0'
             );

# draw pictures
foreach ( [3600, "hour"], [86400, "day"], [604800, "week"], [31536000, "year"] ) {
    my ($time, $scale) = @{$_};
    next if $time < $MINTIME;
    RRDs::graph($picbase . $scale . ".png",
		"--start=-${time}",
		'--lazy',
		'--imgformat=PNG',
		"--title=${hostname} spam statistics (last $scale)",
		"--width=$conf{GRAPH_WIDTH}",
		"--height=$conf{GRAPH_HEIGHT}",
		'--color=BACK#f3f3f3f3',
		'--color=SHADEA#f3f3f3f3',
		'--color=SHADEB#f3f3f3f3',
		'--slope-mode',
		'--logarithmic',
		'--units=si',

		"DEF:ham=${datafile}:ham:AVERAGE",
		"DEF:unsure=${datafile}:unsure:AVERAGE",
		"DEF:spam=${datafile}:spam:AVERAGE",

		'AREA:ham#00F000:ham',
		'STACK:unsure#F0F000:unsure',
		'STACK:spam#F00000:spam',
		'COMMENT:\n',
		'COMMENT:[messages/min]',
		);
    $ERR=RRDs::error;
    die "ERROR while drawing $datafile $time: $ERR\n" if $ERR;
}