/****************************************************************
    * Licensed to the Apache Software Foundation (ASF) under one   *
    * or more contributor license agreements.  See the NOTICE file *
    * distributed with this work for additional information        *
    * regarding copyright ownership.  The ASF licenses this file   *
    * to you under the Apache License, Version 2.0 (the            *
    * "License"); you may not use this file except in compliance   *
    * with the License.  You may obtain a copy of the License at   *
    *                                                              *
   *   http://www.apache.org/licenses/LICENSE-2.0                 *
   *                                                              *
   * Unless required by applicable law or agreed to in writing,   *
   * software distributed under the License is distributed on an  *
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
   * KIND, either express or implied.  See the License for the    *
   * specific language governing permissions and limitations      *
   * under the License.                                           *
   ****************************************************************/
  
  package org.apache.james.transport.mailets;
  
  import javax.mail.MessagingException;
  import javax.mail.internet.MimeMessage;
  
  import org.apache.james.jspf.core.Logger;
  import org.apache.james.jspf.executor.SPFResult;
  import org.apache.james.jspf.impl.DefaultSPF;
  import org.apache.mailet.base.GenericMailet;
  import org.apache.mailet.Mail;
  import org.apache.mailet.MailAddress;
  
  /**
   * Check the ip, sender, helo against SPF.
   * Add the following attributes to the mail object:
   * 
   * org.apache.james.transport.mailets.spf.explanation
   * org.apache.james.transport.mailets.spf.result
   *
   * Sample configuration:
   *
   * <mailet match="All" class="SPF">
   *   <addHeader>true</addHeader>
   *   <debug>false</debug>
   * </mailet>
   */
  public class SPF extends GenericMailet {
      private boolean addHeader = false;
      private org.apache.james.jspf.impl.SPF spf;
      public final static String EXPLANATION_ATTRIBUTE = "org.apache.james.transport.mailets.spf.explanation";
      public final static String RESULT_ATTRIBUTE = "org.apache.james.transport.mailets.spf.result";
  
      /*
       * (non-Javadoc)
       * @see org.apache.mailet.GenericMailet#init()
       */
      public void init() {
          addHeader = new Boolean(getInitParameter("addHeader", "false"))
                  .booleanValue();
          SPFLoggerAdapter logger = new SPFLoggerAdapter(new Boolean(
                  getInitParameter("debug", "false")).booleanValue());
  
          spf = new DefaultSPF(logger);
      }
  
      /*
       * (non-Javadoc)
       * @see org.apache.mailet.GenericMailet#service(org.apache.mailet.Mail)
       */
      public void service(Mail mail) throws MessagingException {
          String sender = null;
          MailAddress senderAddr = mail.getSender();
          String remoteAddr = mail.getRemoteAddr();
          String helo = mail.getRemoteHost();
  
          if (remoteAddr.equals("127.0.0.1") == false) {
              if (senderAddr != null) {
                  sender = senderAddr.toString();
              } else {
                  sender = "";
              }
              SPFResult result = spf.checkSPF(remoteAddr, sender, helo);
              mail.setAttribute(EXPLANATION_ATTRIBUTE, result.getExplanation());
              mail.setAttribute(RESULT_ATTRIBUTE, result.getResult());
  
              log("ip:" + remoteAddr + " from:" + sender + " helo:" + helo
                      + " = " + result.getResult());
              if (addHeader) {
                  try {
                      MimeMessage msg = mail.getMessage();
                      msg.addHeader(result.getHeaderName(), result
                              .getHeaderText());
                      msg.saveChanges();
                  } catch (MessagingException e) {
                      // Ignore not be able to add headers
                  }
              }
          }
      }
  
     private class SPFLoggerAdapter implements Logger {
         private boolean debug = false;
         private String name = "SPFLogger";
 
         public SPFLoggerAdapter(boolean debug) {
             this.debug = debug;
         }
         
         public SPFLoggerAdapter(String name, boolean debug) {
             this.name = name;
             this.debug = debug;
         }
 
         public void debug(String arg0) {
             if (debug) {
                 log(arg0);
             }
         }
 
         public void debug(String arg0, Throwable arg1) {
             if (debug) {
                 log(arg0, arg1);
             }
         }
 
         public void error(String arg0) {
             log(arg0);
         }
 
         public void error(String arg0, Throwable arg1) {
             log(arg0, arg1);
         }
 
         public void fatalError(String arg0) {
             log(arg0);
         }
 
         public void fatalError(String arg0, Throwable arg1) {
             log(arg0, arg1);
         }
 
         public Logger getChildLogger(String childName) {
             return new SPFLoggerAdapter(name + "." + childName, debug);
         }
 
         public void info(String arg0) {
             log(arg0);
         }
 
         public void info(String arg0, Throwable arg1) {
             log(arg0, arg1);
         }
 
         public boolean isDebugEnabled() {
             return debug;
         }
 
         public boolean isErrorEnabled() {
             return true;
         }
 
         public boolean isFatalErrorEnabled() {
             return true;
         }
 
         public boolean isInfoEnabled() {
             return true;
         }
 
         public boolean isWarnEnabled() {
             return true;
         }
 
         public void warn(String arg0) {
             log(arg0);
         }
 
         public void warn(String arg0, Throwable arg1) {
             log(arg0, arg1);
         }
 
     }
 
 }