Quadcap Embeddable Server

com/quadcap/pop3/client/Pop3Agent.java

Go to the documentation of this file.

package com.quadcap.pop3.client;

/* Copyright 1997 - 2003 Quadcap Software.  All rights reserved.
 *
 * This software is distributed under the Quadcap Free Software License.
 * This software may be used or modified for any purpose, personal or
 * commercial.  Open Source redistributions are permitted.  Commercial
 * redistribution of larger works derived from, or works which bundle
 * this software requires a "Commercial Redistribution License"; see
 * http://www.quadcap.com/purchase.
 *
 * Redistributions qualify as "Open Source" under  one of the following terms:
 *   
 *    Redistributions are made at no charge beyond the reasonable cost of
 *    materials and delivery.
 *
 *    Redistributions are accompanied by a copy of the Source Code or by an
 *    irrevocable offer to provide a copy of the Source Code for up to three
 *    years at the cost of materials and delivery.  Such redistributions
 *    must allow further use, modification, and redistribution of the Source
 *    Code under substantially the same terms as this license.
 *
 * Redistributions of source code must retain the copyright notices as they
 * appear in each source code file, these license terms, and the
 * disclaimer/limitation of liability set forth as paragraph 6 below.
 *
 * Redistributions in binary form must reproduce this Copyright Notice,
 * these license terms, and the disclaimer/limitation of liability set
 * forth as paragraph 6 below, in the documentation and/or other materials
 * provided with the distribution.
 *
 * The Software is provided on an "AS IS" basis.  No warranty is
 * provided that the Software is free of defects, or fit for a
 * particular purpose.  
 *
 * Limitation of Liability. Quadcap Software shall not be liable
 * for any damages suffered by the Licensee or any third party resulting
 * from use of the Software.
 */

import java.util.ArrayList;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Properties;
import java.util.List;

import java.io.DataInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import java.net.InetAddress;

import com.quadcap.io.HeaderEnumeration;
import com.quadcap.io.IO;

import com.quadcap.util.Debug;

/**
 * This simple Pop3 agent transfers all new messages in a remote Pop3
 * mailbox into the specified folder in the quadcap message store.
 *
 * <p>A more sophisticated agent would scan the headers first and apply
 * filters to certain messages without having to fetch the bodies.
 *
 * @author Stan Bailes
 */
public class Pop3Agent {
    HashMap                     uidlMap                 = new HashMap();
    String                      hostName                = null;
    int                         portNumber              = 110;
    String                      login                   = null;
    String                      passwd                  = null;
    int                         daysKeep                = 999999;
    boolean                     enabled                 = true;
    
    Session                     pop3                    = null;

    public void write(OutputStream w) throws IOException {
        Iterator iter = uidlMap.keySet().iterator();
        while (iter.hasNext()) {
            UidlEntry u = (UidlEntry)uidlMap.get(iter.next());
            IO.write(w, "UIDL: " + u.toString() + "\n");
        }
    }

    public void read(InputStream r) throws IOException {
        DataInputStream d = new DataInputStream(r);
        String line;
        while ((line = d.readLine()) != null) {
            if (line.startsWith("UIDL: ")) {
                line = line.substring(6).trim();
                UidlEntry uidl = new UidlEntry(line);
                uidlMap.put(uidl.getUidl(), uidl);
            }
        }
    }

    /**
     * Default constructor for factory
     */
    public Pop3Agent() {
    }

    /**
     * Check for mail
     */
    public void run(Properties props, MessageHook hook) {
        try {
            hostName = props.getProperty("host");
            portNumber = Integer.parseInt(props.getProperty("port", "110"));
            login = props.getProperty("user");
            passwd = props.getProperty("passwd");
            daysKeep = Integer.parseInt(props.getProperty("daysKeep", "3"));
            enabled = "true".equalsIgnoreCase(props.getProperty("enabled",
                                                                "true"));
            if (!enabled) return;

            if (pop3 == null) {
                pop3 = new Session(hostName, portNumber);
            }
            pop3.connect();

            int ret = pop3.user(login);
            if (ret != Session.OK) {
                throw new IOException("login failed");
            }

            ret = pop3.pass(passwd);
            if (ret != Session.OK) {
                throw new IOException("login (passwd) failed");
            }
            
            getMail(hook);
        } catch (Throwable t) {
            Debug.print(t);
        } finally {
            try {
                if (pop3 != null) pop3.quit();
            } catch (IOException e) {
                Debug.print(e);
            }
            // ---- we're about to "go to sleep", potentially for a long time,
            // ---- so allow these objects to be gc'ed.
            pop3 = null;
        }
    }


    /**
     * Figure out what's new and deliver it.  Figure out what's old
     * and delete it.
     */
    void getMail(MessageHook hook) throws IOException {
        InputStream uidls = pop3.uidl();
        ArrayList newMessages = new ArrayList();        // list of uidls
        ArrayList delMessages = new ArrayList();        // list of msgnums
        int msgNum = 0;
        String uidl = null;
        StringBuffer sb = new StringBuffer();
        Date now = new Date();
        long ms = daysKeep * 24L * 60 * 60 * 1000;
        Date windowStart = new Date(now.getTime() - ms);
        int c = uidls.read();
        while (c >= 0) {
            while (Character.isDigit((char)c)) {
                sb.append((char)c);
                c = uidls.read();
            }
            if (sb.length() == 0) {
                if (c < 0) break;
                else {
                    c = uidls.read();
                    continue;
                }
            }
            msgNum = Integer.parseInt(sb.toString());

            sb.setLength(0);
            while (Character.isWhitespace((char)c)) {
                c = uidls.read();
            }
            if (c < 0) continue;
            while (c >= 0x21 && c <= 0x7e) {
                sb.append((char)c);
                c = uidls.read();
            }
            uidl = sb.toString();
            sb.setLength(0);
            UidlEntry e = getUidlEntry(uidl);
            if (e == null) {
                e = putUidlEntry(uidl, msgNum, now);
                newMessages.add(e);
            } else {
                e.setMessageNumber(msgNum);
                if (e.getFirstSeen().before(windowStart)) {
                    if (!e.markedForDeletion) {
                        delMessages.add(e);
                        e.markedForDeletion = true;
                    }
                }
            }
            while (c >= 0 && c != 0x0a) {
                c = uidls.read();
            }
            if (c == 0x0a) c = uidls.read();
        }
        getMessages(hook, newMessages);
        deleteMessages(delMessages);
    }

    /**
     * Get the specified list of messages.
     *
     * @param v a ArrayList of UidlEntry types, specifying the messages to get.
     */
    void getMessages(MessageHook hook, ArrayList v) throws IOException {
        for (int i = 0; i < v.size(); i++) {
            UidlEntry e = (UidlEntry)v.get(i);
            int msg = e.getMessageNumber();
            boolean pass = hook.passAllHeaders();
            if (!pass) {
                InputStream is = pop3.top("" + msg, 0);
                try {
                    HashMap map = new HashMap();
                    new HeaderEnumeration(is).getHeaderMap(map);
                    pass = hook.passHeaders(map);
                } finally {
                    is.close();
                }
            }
            if (pass) {
                InputStream body = pop3.retr("" + msg);
                try {
                    if (hook.passMessage(body)) {
                        if (!e.markedForDeletion) {
                            pop3.dele(msg);
                            e.markedForDeletion = true;
                        }
                    }
                } catch (IOException e1) {
                    Debug.print(e1);
                    throw e1;
                } catch (Exception e2) {
                    //#ifdef DEBUG
                    Debug.print(e2);
                    //#endif
                    throw new IOException(e2.toString());
                } finally {
                    body.close();
                }
            }
        }
    }

    /**
     * Delete the specified list of messages.
     *
     * @param v a ArrayList of UidlEntry types, specifying the
     *          messages to delete.
     */
    void deleteMessages(ArrayList v) throws IOException {
        for (int i = 0; i < v.size(); i++) {
            UidlEntry e = (UidlEntry)v.get(i);
            int msg = e.getMessageNumber();
            pop3.dele(msg);
            uidlMap.remove(e.getUidl());
        }
    }
    
    /**
     * Search the map for a specified <b>UIDL</b> entry.
     *
     * @param uidl the UIDL text to search for
     *
     * @return if found, the corresponding entry in the map.  Otherwise, null.
     */
    UidlEntry getUidlEntry(String uidl) {
        return (UidlEntry)uidlMap.get(uidl);
    }

    /**
     * Create and store a new UidlEntry in the map.
     *
     * @param uidl the UIDL text
     * @param msgNum the current POP3 session's message number.
     * @param d the date for this entry.
     *
     * @return the new UidlEntry
     */
    UidlEntry putUidlEntry(String uidl, int msgNum, Date d) {
        UidlEntry e = new UidlEntry(uidl, msgNum, d);
        uidlMap.put(uidl, e);
        return e;
    }
}