Pop3MailReceiver.java

// Copyright (C) 2016 The Android Open Source Project
//
// Licensed 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 com.google.gerrit.server.mail.receive;

import com.google.common.primitives.Ints;
import com.google.gerrit.server.git.WorkQueue;
import com.google.gerrit.server.mail.EmailSettings;
import com.google.gerrit.server.mail.Encryption;
import com.google.inject.Inject;
import com.google.inject.Singleton;
import java.io.BufferedReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.net.pop3.POP3Client;
import org.apache.commons.net.pop3.POP3MessageInfo;
import org.apache.commons.net.pop3.POP3SClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Singleton
public class Pop3MailReceiver extends MailReceiver {
  private static final Logger log = LoggerFactory.getLogger(Pop3MailReceiver.class);

  @Inject
  Pop3MailReceiver(EmailSettings mailSettings, MailProcessor mailProcessor, WorkQueue workQueue) {
    super(mailSettings, mailProcessor, workQueue);
  }

  /**
   * handleEmails will open a connection to the mail server, remove emails where deletion is
   * pending, read new email and close the connection.
   *
   * @param async Determines if processing messages should happen asynchronous.
   */
  @Override
  public synchronized void handleEmails(boolean async) {
    POP3Client pop3;
    if (mailSettings.encryption != Encryption.NONE) {
      pop3 = new POP3SClient(mailSettings.encryption.name(), true);
    } else {
      pop3 = new POP3Client();
    }
    if (mailSettings.port > 0) {
      pop3.setDefaultPort(mailSettings.port);
    }
    try {
      pop3.connect(mailSettings.host);
    } catch (IOException e) {
      log.error("Could not connect to POP3 email server", e);
      return;
    }
    try {
      try {
        if (!pop3.login(mailSettings.username, mailSettings.password)) {
          log.error("Could not login to POP3 email server. Check username and password");
          return;
        }
        try {
          POP3MessageInfo[] messages = pop3.listMessages();
          if (messages == null) {
            log.error("Could not retrieve message list via POP3");
            return;
          }
          log.info("Received " + messages.length + " messages via POP3");
          // Fetch messages
          List<MailMessage> mailMessages = new ArrayList<>();
          for (POP3MessageInfo msginfo : messages) {
            if (msginfo == null) {
              // Message was deleted
              continue;
            }
            try (BufferedReader reader = (BufferedReader) pop3.retrieveMessage(msginfo.number)) {
              if (reader == null) {
                log.error(
                    "Could not retrieve POP3 message header for message {}", msginfo.identifier);
                return;
              }
              int[] message = fetchMessage(reader);
              MailMessage mailMessage = RawMailParser.parse(message);
              // Delete messages where deletion is pending. This requires
              // knowing the integer message ID of the email. We therefore parse
              // the message first and extract the Message-ID specified in RFC
              // 822 and delete the message if deletion is pending.
              if (pendingDeletion.contains(mailMessage.id())) {
                if (pop3.deleteMessage(msginfo.number)) {
                  pendingDeletion.remove(mailMessage.id());
                } else {
                  log.error("Could not delete message " + msginfo.number);
                }
              } else {
                // Process message further
                mailMessages.add(mailMessage);
              }
            } catch (MailParsingException e) {
              log.error("Could not parse message " + msginfo.number);
            }
          }
          dispatchMailProcessor(mailMessages, async);
        } finally {
          pop3.logout();
        }
      } finally {
        pop3.disconnect();
      }
    } catch (IOException e) {
      log.error("Error while issuing POP3 command", e);
    }
  }

  public final int[] fetchMessage(BufferedReader reader) throws IOException {
    List<Integer> character = new ArrayList<>();
    int ch;
    while ((ch = reader.read()) != -1) {
      character.add(ch);
    }
    return Ints.toArray(character);
  }
}