source: plugins/1.0/spam-filter/tracspamfilter/filters/regex.py

# -*- coding: utf-8 -*-
#
# Copyright (C) 2005-2006 Edgewall Software
# Copyright (C) 2005 Matthew Good <trac@matt-good.net>
# Copyright (C) 2006 Christopher Lenz <cmlenz@gmx.de>
# All rights reserved.
#
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
# are also available at http://trac.edgewall.com/license.html.
#
# This software consists of voluntary contributions made by many
# individuals. For the exact contribution history, see the revision
# history and logs, available at http://projects.edgewall.com/trac/.
#
# Author: Matthew Good <trac@matt-good.net>

import re

from trac.config import BoolOption, IntOption, Option
from trac.core import Component, TracError, implements
from trac.util.html import html as tag
from trac.wiki.api import IWikiChangeListener, IWikiPageManipulator
from trac.wiki.model import WikiPage

from tracspamfilter.api import IFilterStrategy, N_, tag_


class RegexFilterStrategy(Component):
    """Spam filter based on regular expressions defined in BadContent page.
    """
    implements(IFilterStrategy, IWikiChangeListener, IWikiPageManipulator)

    karma_points = IntOption('spam-filter', 'regex_karma', '5',
        """By how many points a match with a pattern on the BadContent page
        impacts the overall karma of a submission.""",
        doc_domain='tracspamfilter')

    badcontent_file = Option('spam-filter', 'badcontent_file', '',
        """Local file to be loaded to get BadContent. Can be used in
        addition to BadContent wiki page.""",
        doc_domain='tracspamfilter')

    show_blacklisted = BoolOption('spam-filter', 'show_blacklisted', 'true',
        "Show the matched bad content patterns in rejection message.",
        doc_domain='tracspamfilter')

    def __init__(self):
        self.patterns = []
        page = WikiPage(self.env, 'BadContent')
        if page.exists:
            try:
                self._load_patterns(page)
            except TracError:
                pass
        if self.badcontent_file != '':
            with open(self.badcontent_file, 'r') as file:
                if file is None:
                    self.log.warning("BadContent file cannot be opened")
                else:
                    lines = file.read().splitlines()
                    pat = [re.compile(p.strip()) for p in lines if p.strip()]
                    self.log.debug("Loaded %s patterns from BadContent file",
                                   len(pat))
                    self.patterns += pat

    # IFilterStrategy implementation

    def is_external(self):
        return False

    def test(self, req, author, content, ip):
        gotcha = []
        points = 0
        if author is not None and author != 'anonymous':
            testcontent = author + '\n' + content
        else:
            testcontent = content
        for pattern in self.patterns:
            match = pattern.search(testcontent)
            if match:
                gotcha.append("'%s'" % pattern.pattern)
                self.log.debug('Pattern %s found in submission',
                               pattern.pattern)
                points -= abs(self.karma_points)
        if points != 0:
            if self.show_blacklisted:
                matches = ", ".join(gotcha)
                return points, N_("Content contained these blacklisted "
                                  "patterns: %s"), matches
            else:
                return points, N_("Content contained %s blacklisted "
                                  "patterns"), str(len(gotcha))

    def train(self, req, author, content, ip, spam=True):
        return 0

    # IWikiPageManipulator implementation

    def prepare_wiki_page(self, req, page, fields):
        pass

    def validate_wiki_page(self, req, page):
        if page.name == 'BadContent':
            try:
                self._load_patterns(page)
            except TracError, e:
                return [(None, e)]
        return []

    # IWikiChangeListener implementation

    def wiki_page_changed(self, page, *args):
        if page.name == 'BadContent':
            self._load_patterns(page)

    wiki_page_added = wiki_page_changed

    wiki_page_version_deleted = wiki_page_changed

    def wiki_page_deleted(self, page):
        if page.name == 'BadContent':
            self.patterns = []

    # Internal methods

    def _load_patterns(self, page):
        if '{{{' in page.text and '}}}' in page.text:
            lines = page.text.split('{{{', 1)[1].split('}}}', 1)[0]
            lines = [l.strip() for l in lines.splitlines() if l.strip()]
            for p in lines:
                try:
                    self.patterns.append(re.compile(p))
                except re.error, e:
                    self.log.debug("Error in pattern %s: %s", p, e)
                    raise TracError(tag_("Error in pattern %(pattern)s: "
                                         "%(error)s.", pattern=tag.tt(p),
                                         error=tag.i(e)))
            self.log.debug("Loaded %s patterns from BadContent",
                           len(self.patterns))
        else:
            self.log.warning("BadContent page does not contain any patterns")
            self.patterns = []