1  /*
     2   * Copyright (c) 2003-2006, Simon Brown
     3   * All rights reserved.
     4   *
     5   * Redistribution and use in source and binary forms, with or without
     6   * modification, are permitted provided that the following conditions are met:
     7   *
     8   *   - Redistributions of source code must retain the above copyright
     9   *     notice, this list of conditions and the following disclaimer.
    10   *
    11   *   - Redistributions in binary form must reproduce the above copyright
    12   *     notice, this list of conditions and the following disclaimer in
    13   *     the documentation and/or other materials provided with the
    14   *     distribution.
    15   *
    16   *   - Neither the name of Pebble nor the names of its contributors may
    17   *     be used to endorse or promote products derived from this software
    18   *     without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    30   * POSSIBILITY OF SUCH DAMAGE.
    31   */
    32  package net.sourceforge.pebble.event.response;
    33  
    34  import net.sourceforge.pebble.PluginProperties;
    35  import net.sourceforge.pebble.domain.Comment;
    36  import net.sourceforge.pebble.domain.Response;
    37  import org.apache.commons.logging.Log;
    38  import org.apache.commons.logging.LogFactory;
    39  
    40  /**
    41   * Checks the spam score of comments and TrackBacks and if greater than the
    42   * threshold, marks them as rejected.
    43   *
    44   * @author Simon Brown
    45   */
         /* 
    P/P   *  Method: void net.sourceforge.pebble.event.response.SpamScoreListener()
          */
    46  public class SpamScoreListener extends BlogEntryResponseListenerSupport {
    47  
    48    /** the log used by this class */
           /* 
    P/P     *  Method: net.sourceforge.pebble.event.response.SpamScoreListener__static_init
            * 
            *  Postconditions:
            *    init'ed(log)
            */
    49    private static final Log log = LogFactory.getLog(SpamScoreListener.class);
    50  
    51    /** the default threshold for the spam score */
    52    public static final int DEFAULT_THRESHOLD = 1;
    53  
    54    /** the name of the threshold property for comments */
    55    public static final String COMMENT_THRESHOLD_KEY = "SpamScoreListener.commentThreshold";
    56  
    57    /** the name of the threshold property for TrackBacks */
    58    public static final String TRACKBACK_THRESHOLD_KEY = "SpamScoreListener.trackbackThreshold";
    59  
    60    /**
    61     * Called when a comment or TrackBack has been added.
    62     *
    63     * @param response a Response
    64     */
    65    protected void blogEntryResponseAdded(Response response) {
             /* 
    P/P       *  Method: void blogEntryResponseAdded(Response)
              * 
              *  Preconditions:
              *    response != null
              * 
              *  Presumptions:
              *    org.apache.commons.logging.LogFactory:getLog(...)@49 != null
              * 
              *  Preconditions:
              *    response.blogEntry != null
              *    response.blogEntry.blog.pluginProperties != null
              *    response.blogEntry.blog != null
              *    init'ed(response.spamScore)
              *    (soft) init'ed(response.title)
              * 
              *  Postconditions:
              *    response.state == One-of{old response.state, &net.sourceforge.pebble.domain.State__static_init.new State(State__static_init#2)}
              * 
              *  Test Vectors:
              *    net.sourceforge.pebble.PluginProperties:hasProperty(...)@74: {0}, {1}
              */
    66      PluginProperties props = response.getBlogEntry().getBlog().getPluginProperties();
    67      String propertyName = "";
    68      if (response instanceof Comment) {
    69        propertyName = COMMENT_THRESHOLD_KEY;
    70      } else {
    71        propertyName = TRACKBACK_THRESHOLD_KEY;
    72      }
    73      int threshold = DEFAULT_THRESHOLD;
    74      if (props.hasProperty(propertyName)) {
    75        try {
    76          threshold = Integer.parseInt(props.getProperty(propertyName));
    77        } catch (NumberFormatException nfe) {
    78          log.error(nfe.getMessage());
    79          // do nothing, the value has already been defaulted
    80        }
    81      }
    82  
    83      if (response.getSpamScore() > threshold) {
    84        log.info(response.getTitle() + " rejected : spam score is " + response.getSpamScore() + ", threshold is " + threshold);
    85        response.setRejected();
    86      }
    87    }
    88  
    89  }