Coverage Report - org.mule.transport.email.RetrieveMessageReceiver
 
Classes in this File Line Coverage Branch Coverage Complexity
RetrieveMessageReceiver
0%
0/134
0%
0/62
0
 
 1  
 /*
 2  
  * $Id: RetrieveMessageReceiver.java 19698 2010-09-22 18:33:58Z esteban.robles $
 3  
  * --------------------------------------------------------------------------------------
 4  
  * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 5  
  *
 6  
  * The software in this package is published under the terms of the CPAL v1.0
 7  
  * license, a copy of which has been included with this distribution in the
 8  
  * LICENSE.txt file.
 9  
  */
 10  
 
 11  
 package org.mule.transport.email;
 12  
 
 13  
 import org.mule.api.MuleException;
 14  
 import org.mule.api.MuleMessage;
 15  
 import org.mule.api.construct.FlowConstruct;
 16  
 import org.mule.api.endpoint.InboundEndpoint;
 17  
 import org.mule.api.lifecycle.CreateException;
 18  
 import org.mule.api.transport.Connector;
 19  
 import org.mule.api.transport.ReceiveException;
 20  
 import org.mule.transport.AbstractPollingMessageReceiver;
 21  
 import org.mule.transport.email.i18n.EmailMessages;
 22  
 import org.mule.util.FileUtils;
 23  
 import org.mule.util.StringUtils;
 24  
 import org.mule.util.UUID;
 25  
 
 26  
 import java.io.File;
 27  
 import java.io.FileOutputStream;
 28  
 import java.io.IOException;
 29  
 
 30  
 import javax.mail.Address;
 31  
 import javax.mail.Flags;
 32  
 import javax.mail.Folder;
 33  
 import javax.mail.Message;
 34  
 import javax.mail.MessagingException;
 35  
 import javax.mail.Store;
 36  
 import javax.mail.event.MessageCountEvent;
 37  
 import javax.mail.event.MessageCountListener;
 38  
 import javax.mail.internet.InternetAddress;
 39  
 import javax.mail.internet.MimeMessage;
 40  
 
 41  
 /**
 42  
  * Poll a mailbox for messages, remove the messages and route them as events into
 43  
  * Mule.
 44  
  * <p/>
 45  
  * This contains a reference to a mail folder (and also the endpoint and connector,
 46  
  * via superclasses)
 47  
  */
 48  
 public class RetrieveMessageReceiver extends AbstractPollingMessageReceiver implements MessageCountListener
 49  
 {
 50  0
     private Folder folder = null;
 51  0
     private Folder moveToFolder = null;
 52  
     private boolean backupEnabled;
 53  0
     private String backupFolder = null;
 54  
 
 55  
     public RetrieveMessageReceiver(Connector connector,
 56  
                                    FlowConstruct flowConstruct,
 57  
                                    InboundEndpoint endpoint,
 58  
                                    long checkFrequency,
 59  
                                    boolean backupEnabled,
 60  
                                    String backupFolder) throws CreateException
 61  
     {
 62  0
         super(connector, flowConstruct, endpoint);
 63  0
         this.backupFolder = backupFolder;
 64  0
         this.backupEnabled = backupEnabled;
 65  0
         this.setFrequency(checkFrequency);
 66  0
     }
 67  
 
 68  
     private AbstractRetrieveMailConnector castConnector()
 69  
     {
 70  0
         return (AbstractRetrieveMailConnector) getConnector();
 71  
     }
 72  
 
 73  
     @Override
 74  
     protected void doConnect() throws Exception
 75  
     {
 76  0
         SessionDetails session = castConnector().getSessionDetails(endpoint);
 77  
 
 78  0
         Store store = session.newStore();
 79  0
         store.connect();
 80  0
         folder = store.getFolder(castConnector().getMailboxFolder());
 81  0
         if (castConnector().getMoveToFolder() != null)
 82  
         {
 83  0
             moveToFolder = store.getFolder(castConnector().getMoveToFolder());
 84  0
             moveToFolder.open(Folder.READ_WRITE);
 85  
         }
 86  
 
 87  
         // set default value if empty/null
 88  0
         if (StringUtils.isEmpty(backupFolder))
 89  
         {
 90  0
             this.backupFolder = connector.getMuleContext().getConfiguration().getWorkingDirectory()
 91  
                                 + "/mail/" + folder.getName();
 92  
         }
 93  
 
 94  0
         if (backupFolder != null && !this.backupFolder.endsWith(File.separator))
 95  
         {
 96  0
             this.backupFolder += File.separator;
 97  
         }
 98  0
     }
 99  
 
 100  
     @Override
 101  
     protected void doDisconnect() throws Exception
 102  
     {
 103  
         // nothing to do here
 104  0
     }
 105  
 
 106  
     @Override
 107  
     protected void doStop()
 108  
     {
 109  0
         if (folder != null)
 110  
         {
 111  0
             folder.removeMessageCountListener(this);
 112  
         }
 113  0
     }
 114  
 
 115  
     @Override
 116  
     protected void doStart() throws MuleException
 117  
     {
 118  0
         super.doStart();
 119  0
         folder.addMessageCountListener(this);
 120  0
     }
 121  
 
 122  
     public void messagesAdded(MessageCountEvent event)
 123  
     {
 124  0
         Message messages[] = event.getMessages();
 125  0
         if (messages != null)
 126  
         {
 127  0
             MuleMessage message = null;
 128  0
             for (int i = 0; i < messages.length; i++)
 129  
             {
 130  
                 try
 131  
                 {
 132  0
                     if (!messages[i].getFlags().contains(Flags.Flag.DELETED)
 133  
                         && !messages[i].getFlags().contains(Flags.Flag.SEEN))
 134  
                     {
 135  0
                         MimeMessage mimeMessage = new MimeMessage((MimeMessage) messages[i]);
 136  0
                         storeMessage(mimeMessage);
 137  0
                         message = createMuleMessage(mimeMessage, endpoint.getEncoding());
 138  
 
 139  0
                         if (castConnector().isDeleteReadMessages())
 140  
                         {
 141  
                             // Mark as deleted
 142  0
                             messages[i].setFlag(Flags.Flag.DELETED, true);
 143  
                         }
 144  
                         else
 145  
                         {
 146  0
                             if (this.getEndpoint().getFilter().accept(message))
 147  
                             {
 148  0
                                 Flags.Flag flag = castConnector().getDefaultProcessMessageAction();
 149  0
                                 if (flag != null)
 150  
                                 {
 151  0
                                     messages[i].setFlag(flag, true);
 152  
                                 }
 153  0
                             }
 154  
                             else
 155  
                             {
 156  0
                                 messages[i].setFlag(Flags.Flag.SEEN, false);
 157  
                             }
 158  
                        }
 159  0
                         routeMessage(message);
 160  
                     }
 161  
                 }
 162  0
                 catch (MuleException e)
 163  
                 {
 164  0
                     getConnector().getMuleContext().getExceptionListener().handleException(e);
 165  
                 }
 166  0
                 catch (Exception e)
 167  
                 {
 168  
                     Exception forwarded;
 169  
 
 170  0
                     if (message != null)
 171  
                     {
 172  0
                         forwarded = new org.mule.api.MessagingException(EmailMessages.routingError(), message, e);
 173  
                     }
 174  
                     else
 175  
                     {
 176  0
                         forwarded = new ReceiveException(endpoint, -1, e);
 177  
                     }
 178  
 
 179  0
                     getConnector().getMuleContext().getExceptionListener().handleException(forwarded);
 180  0
                 }
 181  
             }
 182  
             // Lets move all messages in one go
 183  0
             if (moveToFolder != null)
 184  
             {
 185  
                 try
 186  
                 {
 187  0
                     folder.copyMessages(messages, moveToFolder);
 188  
                 }
 189  0
                 catch (MessagingException e)
 190  
                 {
 191  0
                     getConnector().getMuleContext().getExceptionListener().handleException(e);
 192  0
                 }
 193  
             }
 194  
         }
 195  0
     }
 196  
 
 197  
     public void messagesRemoved(MessageCountEvent event)
 198  
     {
 199  0
         if (logger.isDebugEnabled())
 200  
         {
 201  0
             Message messages[] = event.getMessages();
 202  0
             for (int i = 0; i < messages.length; i++)
 203  
             {
 204  
                 try
 205  
                 {
 206  0
                     logger.debug("Message removed: " + messages[i].getSubject());
 207  
                 }
 208  0
                 catch (MessagingException ignore)
 209  
                 {
 210  0
                     logger.debug("ignoring exception: " + ignore.getMessage());
 211  0
                 }
 212  
             }
 213  
         }
 214  0
     }
 215  
 
 216  
     /** @return the current Mail folder */
 217  
     public Folder getFolder()
 218  
     {
 219  0
         return folder;
 220  
     }
 221  
 
 222  
     /** @param folder */
 223  
     public synchronized void setFolder(Folder folder)
 224  
     {
 225  0
         if (folder == null)
 226  
         {
 227  0
             throw new IllegalArgumentException("Mail folder cannot be null");
 228  
         }
 229  0
         this.folder = folder;
 230  0
         synchronized (this.folder)
 231  
         {
 232  0
             if (!this.folder.isOpen())
 233  
             {
 234  
                 try
 235  
                 {
 236  0
                     this.folder.open(Folder.READ_WRITE);
 237  
                 }
 238  0
                 catch (MessagingException e)
 239  
                 {
 240  0
                     logger.warn("Failed to open folder: " + folder.getFullName(), e);
 241  0
                 }
 242  
             }
 243  0
         }
 244  0
     }
 245  
 
 246  
     /**
 247  
      * Helper method for testing which stores a copy of the message locally as the
 248  
      * POP3
 249  
      * <p/>
 250  
      * message will be deleted from the server
 251  
      * 
 252  
      * @param msg the message to store
 253  
      * @throws IOException If a failure happens writing the message
 254  
      * @throws MessagingException If a failure happens reading the message
 255  
      */
 256  
     protected void storeMessage(Message msg) throws IOException, MessagingException
 257  
     {
 258  0
         if (backupEnabled)
 259  
         {
 260  0
             String filename = msg.getFileName();
 261  0
             if (filename == null)
 262  
             {
 263  0
                 Address[] from = msg.getFrom();
 264  0
                 if (from != null && from.length > 0)
 265  
                 {
 266  0
                     filename = from[0] instanceof InternetAddress
 267  
                                                                  ? ((InternetAddress) from[0]).getAddress()
 268  
                                                                  : from[0].toString();
 269  
                 }
 270  
                 else
 271  
                 {
 272  0
                     filename = "(no from address)";
 273  
                 }
 274  0
                 filename += "[" + UUID.getUUID() + "]";
 275  
             }
 276  0
             filename = FileUtils.prepareWinFilename(filename);
 277  0
             filename = backupFolder + filename + ".msg";
 278  0
             if (logger.isDebugEnabled())
 279  
             {
 280  0
                 logger.debug("Writing message to: " + filename);
 281  
             }
 282  0
             File f = FileUtils.createFile(filename);
 283  0
             FileOutputStream fos = new FileOutputStream(f);
 284  0
             msg.writeTo(fos);
 285  
         }
 286  0
     }
 287  
 
 288  
     @Override
 289  
     public synchronized void poll()
 290  
     {
 291  
         try
 292  
         {
 293  
             try
 294  
             {
 295  0
                 if (!folder.isOpen())
 296  
                 {
 297  0
                     folder.open(Folder.READ_WRITE);
 298  
                 }
 299  
             }
 300  0
             catch (Exception e)
 301  
             {
 302  0
                 if (logger.isDebugEnabled())
 303  
                 {
 304  0
                     logger.debug("ignoring exception: " + e.getMessage());
 305  
                 }
 306  0
             }
 307  
 
 308  0
             int count = folder.getMessageCount();
 309  0
             if (count > 0)
 310  
             {
 311  0
                 Message[] messages = folder.getMessages();
 312  0
                 MessageCountEvent event = new MessageCountEvent(folder, MessageCountEvent.ADDED, true,
 313  
                     messages);
 314  0
                 messagesAdded(event);
 315  0
             }
 316  0
             else if (count == -1)
 317  
             {
 318  0
                 throw new MessagingException("Cannot monitor folder: " + folder.getFullName()
 319  
                                              + " as folder is closed");
 320  
             }
 321  
         }
 322  0
         catch (MessagingException e)
 323  
         {
 324  0
             getConnector().getMuleContext().getExceptionListener().handleException(e);
 325  
         }
 326  
         finally
 327  
         {
 328  0
             try
 329  
             {
 330  0
                 folder.close(true); // close and expunge deleted messages
 331  
             }
 332  0
             catch (Exception e)
 333  
             {
 334  0
                 logger.error("Failed to close pop3  inbox: " + e.getMessage());
 335  0
             }
 336  0
         }
 337  0
     }
 338  
 
 339  
     @Override
 340  
     protected void doDispose()
 341  
     {
 342  0
         if (null != folder)
 343  
         {
 344  0
             folder.removeMessageCountListener(this);
 345  0
             if (folder.isOpen())
 346  
             {
 347  
                 try
 348  
                 {
 349  
 
 350  0
                     folder.close(true);
 351  
                 }
 352  0
                 catch (Exception e)
 353  
                 {
 354  0
                     logger.debug("ignoring exception: " + e.getMessage(), e);
 355  0
                 }
 356  
             }
 357  
         }
 358  0
     }
 359  
 
 360  
     @Override
 361  
     protected MuleMessage handleUnacceptedFilter(MuleMessage message)
 362  
     {
 363  0
         super.handleUnacceptedFilter(message);
 364  0
         if (message.getPayload() instanceof Message)
 365  
         {
 366  0
             Message msg = (Message) message.getPayload();
 367  
             try
 368  
             {
 369  0
                 msg.setFlag(Flags.Flag.DELETED, endpoint.isDeleteUnacceptedMessages());
 370  
             }
 371  0
             catch (MessagingException e)
 372  
             {
 373  0
                 logger.error("failed to set message deleted: " + e.getMessage(), e);
 374  0
             }
 375  
         }
 376  0
         return message;
 377  
     }
 378  
 }