#!/usr/bin/python
# whitlist_spf -- Courier filter which checks SPF records using the "spf" module
# Copyright (C) 2007-2008  Gordon Messmer <gordon@dragonsdawn.net>
#
# This file is part of pythonfilter.
#
# pythonfilter 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.
#
# pythonfilter 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 pythonfilter.  If not, see <http://www.gnu.org/licenses/>.

import sys
import courier.control
import spf


def initFilter():
    # Record in the system log that this filter was initialized.
    sys.stderr.write('Initialized the whitelist_spf python filter\n')


def doFilter(bodyFile, controlFileList):
    """Use the SPF mechanism to whitelist email."""
    try:
        sendersMta = courier.control.getSendersMta(controlFileList)
        sendersIp = courier.control.getSendersIP(controlFileList)
        sender = courier.control.getSender(controlFileList)
    except:
        return '451 Internal failure locating control files'

    # Don't waste time on DSNs.
    if sender == '':
        return ''

    helo = sendersMta.split(' ')[1]
    (spfResult, spfExplanation) = spf.check2(sendersIp, sender, helo)
    if spfResult == 'pass':
        return '200 Ok'
    return ''


if __name__ == '__main__':
    # Run this script with the name of a properly formatted control
    # file as an argument, and it'll print either "200 Ok" to
    # indicate that the sender is whitelisted, or nothing to
    # indicate that the remaining filters would be run.
    if not sys.argv[1:]:
        print 'Use:  whitelist_spf.py <control file>'
        sys.exit(1)
    initFilter()
    print doFilter('', sys.argv[1:])