3397 lines
131 KiB
Java
3397 lines
131 KiB
Java
/*
|
|
* DavMail POP/IMAP/SMTP/CalDav/LDAP Exchange Gateway
|
|
* Copyright (C) 2009 Mickael Guessant
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
package davmail.exchange;
|
|
|
|
import davmail.BundleMessage;
|
|
import davmail.Settings;
|
|
import davmail.exception.DavMailAuthenticationException;
|
|
import davmail.exception.DavMailException;
|
|
import davmail.http.DavGatewayHttpClientFacade;
|
|
import davmail.http.DavGatewayOTPPrompt;
|
|
import davmail.util.StringUtil;
|
|
import org.apache.commons.httpclient.*;
|
|
import org.apache.commons.httpclient.methods.GetMethod;
|
|
import org.apache.commons.httpclient.methods.PostMethod;
|
|
import org.apache.commons.httpclient.params.HttpClientParams;
|
|
import org.apache.commons.httpclient.util.URIUtil;
|
|
import org.apache.log4j.Logger;
|
|
import org.htmlcleaner.CommentToken;
|
|
import org.htmlcleaner.HtmlCleaner;
|
|
import org.htmlcleaner.TagNode;
|
|
|
|
import javax.mail.Address;
|
|
import javax.mail.MessagingException;
|
|
import javax.mail.internet.InternetAddress;
|
|
import javax.mail.internet.MimeMessage;
|
|
import javax.mail.internet.MimeMultipart;
|
|
import javax.mail.internet.MimePart;
|
|
import javax.mail.util.SharedByteArrayInputStream;
|
|
import java.io.*;
|
|
import java.net.NoRouteToHostException;
|
|
import java.net.UnknownHostException;
|
|
import java.text.ParseException;
|
|
import java.text.SimpleDateFormat;
|
|
import java.util.*;
|
|
|
|
/**
|
|
* Exchange session through Outlook Web Access (DAV)
|
|
*/
|
|
public abstract class ExchangeSession {
|
|
|
|
protected static final Logger LOGGER = Logger.getLogger("davmail.exchange.ExchangeSession");
|
|
|
|
/**
|
|
* Reference GMT timezone to format dates
|
|
*/
|
|
public static final SimpleTimeZone GMT_TIMEZONE = new SimpleTimeZone(0, "GMT");
|
|
|
|
protected static final Set<String> USER_NAME_FIELDS = new HashSet<String>();
|
|
|
|
static {
|
|
USER_NAME_FIELDS.add("username");
|
|
USER_NAME_FIELDS.add("txtUserName");
|
|
USER_NAME_FIELDS.add("userid");
|
|
USER_NAME_FIELDS.add("SafeWordUser");
|
|
}
|
|
|
|
protected static final Set<String> PASSWORD_FIELDS = new HashSet<String>();
|
|
|
|
static {
|
|
PASSWORD_FIELDS.add("password");
|
|
PASSWORD_FIELDS.add("txtUserPass");
|
|
PASSWORD_FIELDS.add("pw");
|
|
PASSWORD_FIELDS.add("basicPassword");
|
|
}
|
|
|
|
protected static final Set<String> TOKEN_FIELDS = new HashSet<String>();
|
|
|
|
static {
|
|
TOKEN_FIELDS.add("SafeWordPassword");
|
|
}
|
|
|
|
protected static final int FREE_BUSY_INTERVAL = 15;
|
|
|
|
protected static final String PUBLIC_ROOT = "/public";
|
|
protected static final String CALENDAR = "calendar";
|
|
/**
|
|
* Contacts folder logical name
|
|
*/
|
|
public static final String CONTACTS = "contacts";
|
|
protected static final String ADDRESSBOOK = "addressbook";
|
|
protected static final String INBOX = "INBOX";
|
|
protected static final String LOWER_CASE_INBOX = "inbox";
|
|
protected static final String SENT = "Sent";
|
|
protected static final String DRAFTS = "Drafts";
|
|
protected static final String TRASH = "Trash";
|
|
protected static final String JUNK = "Junk";
|
|
protected static final String UNSENT = "Unsent Messages";
|
|
|
|
protected String publicFolderUrl;
|
|
|
|
/**
|
|
* Base user mailboxes path (used to select folder)
|
|
*/
|
|
protected String mailPath;
|
|
protected String rootPath;
|
|
protected String email;
|
|
protected String alias;
|
|
protected final HttpClient httpClient;
|
|
|
|
private final String userName;
|
|
|
|
private boolean disableGalLookup;
|
|
private static final String YYYY_MM_DD_HH_MM_SS = "yyyy/MM/dd HH:mm:ss";
|
|
private static final String YYYYMMDD_T_HHMMSS_Z = "yyyyMMdd'T'HHmmss'Z'";
|
|
private static final String YYYY_MM_DD_T_HHMMSS_Z = "yyyy-MM-dd'T'HH:mm:ss'Z'";
|
|
private static final String YYYY_MM_DD_T_HHMMSS_SSS_Z = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
|
|
|
|
/**
|
|
* Logon form user name field, default is username.
|
|
*/
|
|
private String userNameInput = "username";
|
|
/**
|
|
* Logon form password field, default is password.
|
|
*/
|
|
private String passwordInput = "password";
|
|
|
|
/**
|
|
* Create an exchange session for the given URL.
|
|
* The session is established for given userName and password
|
|
*
|
|
* @param url Exchange url
|
|
* @param userName user login name
|
|
* @param password user password
|
|
* @throws IOException on error
|
|
*/
|
|
public ExchangeSession(String url, String userName, String password) throws IOException {
|
|
this.userName = userName;
|
|
try {
|
|
boolean isBasicAuthentication = isBasicAuthentication(url);
|
|
|
|
httpClient = DavGatewayHttpClientFacade.getInstance(url, userName, password);
|
|
|
|
// get webmail root url
|
|
// providing credentials
|
|
// manually follow redirect
|
|
HttpMethod method = DavGatewayHttpClientFacade.executeFollowRedirects(httpClient, url);
|
|
|
|
if (isBasicAuthentication) {
|
|
int status = method.getStatusCode();
|
|
|
|
if (status == HttpStatus.SC_UNAUTHORIZED) {
|
|
method.releaseConnection();
|
|
throw new DavMailAuthenticationException("EXCEPTION_AUTHENTICATION_FAILED");
|
|
} else if (status != HttpStatus.SC_OK) {
|
|
method.releaseConnection();
|
|
throw DavGatewayHttpClientFacade.buildHttpException(method);
|
|
}
|
|
} else {
|
|
method = formLogin(httpClient, method, userName, password);
|
|
}
|
|
|
|
// avoid 401 roundtrips, only if NTLM is disabled
|
|
if (!DavGatewayHttpClientFacade.hasNTLM(httpClient)) {
|
|
httpClient.getParams().setParameter(HttpClientParams.PREEMPTIVE_AUTHENTICATION, true);
|
|
}
|
|
|
|
buildSessionInfo(method);
|
|
|
|
} catch (DavMailAuthenticationException exc) {
|
|
LOGGER.error(exc.getMessage());
|
|
throw exc;
|
|
} catch (UnknownHostException exc) {
|
|
BundleMessage message = new BundleMessage("EXCEPTION_CONNECT", exc.getClass().getName(), exc.getMessage());
|
|
ExchangeSession.LOGGER.error(message);
|
|
throw new DavMailException("EXCEPTION_DAVMAIL_CONFIGURATION", message);
|
|
} catch (IOException exc) {
|
|
LOGGER.error(BundleMessage.formatLog("EXCEPTION_EXCHANGE_LOGIN_FAILED", exc));
|
|
throw new DavMailException("EXCEPTION_EXCHANGE_LOGIN_FAILED", exc);
|
|
}
|
|
LOGGER.debug("Session " + this + " created");
|
|
}
|
|
|
|
protected static String formatSearchDate(Date date) {
|
|
SimpleDateFormat dateFormatter = new SimpleDateFormat(YYYY_MM_DD_HH_MM_SS, Locale.ENGLISH);
|
|
dateFormatter.setTimeZone(GMT_TIMEZONE);
|
|
return dateFormatter.format(date);
|
|
}
|
|
|
|
/**
|
|
* Return standard zulu date formatter.
|
|
* @return zulu date formatter
|
|
*/
|
|
public static SimpleDateFormat getZuluDateFormat() {
|
|
SimpleDateFormat dateFormat = new SimpleDateFormat(YYYYMMDD_T_HHMMSS_Z, Locale.ENGLISH);
|
|
dateFormat.setTimeZone(GMT_TIMEZONE);
|
|
return dateFormat;
|
|
}
|
|
|
|
protected static SimpleDateFormat getExchangeZuluDateFormat() {
|
|
SimpleDateFormat dateFormat = new SimpleDateFormat(YYYY_MM_DD_T_HHMMSS_Z, Locale.ENGLISH);
|
|
dateFormat.setTimeZone(GMT_TIMEZONE);
|
|
return dateFormat;
|
|
}
|
|
|
|
protected static SimpleDateFormat getExchangeZuluDateFormatMillisecond() {
|
|
SimpleDateFormat dateFormat = new SimpleDateFormat(YYYY_MM_DD_T_HHMMSS_SSS_Z, Locale.ENGLISH);
|
|
dateFormat.setTimeZone(GMT_TIMEZONE);
|
|
return dateFormat;
|
|
}
|
|
|
|
protected static Date parseDate(String dateString) throws ParseException {
|
|
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMdd");
|
|
dateFormat.setTimeZone(GMT_TIMEZONE);
|
|
return dateFormat.parse(dateString);
|
|
}
|
|
|
|
|
|
/**
|
|
* Test if the session expired.
|
|
*
|
|
* @return true this session expired
|
|
* @throws NoRouteToHostException on error
|
|
* @throws UnknownHostException on error
|
|
*/
|
|
public abstract boolean isExpired() throws NoRouteToHostException, UnknownHostException;
|
|
|
|
/**
|
|
* Test authentication mode : form based or basic.
|
|
*
|
|
* @param url exchange base URL
|
|
* @return true if basic authentication detected
|
|
* @throws IOException unable to connect to exchange
|
|
*/
|
|
protected boolean isBasicAuthentication(String url) throws IOException {
|
|
return DavGatewayHttpClientFacade.getHttpStatus(url) == HttpStatus.SC_UNAUTHORIZED;
|
|
}
|
|
|
|
protected String getAbsoluteUri(HttpMethod method, String path) throws URIException {
|
|
URI uri = method.getURI();
|
|
if (path != null) {
|
|
// reset query string
|
|
uri.setQuery(null);
|
|
if (path.startsWith("/")) {
|
|
// path is absolute, replace method path
|
|
uri.setPath(path);
|
|
} else if (path.startsWith("http://") || path.startsWith("https://")) {
|
|
return path;
|
|
} else {
|
|
// relative path, build new path
|
|
String currentPath = method.getPath();
|
|
int end = currentPath.lastIndexOf('/');
|
|
if (end >= 0) {
|
|
uri.setPath(currentPath.substring(0, end + 1) + path);
|
|
} else {
|
|
throw new URIException(uri.getURI());
|
|
}
|
|
}
|
|
}
|
|
return uri.getURI();
|
|
}
|
|
|
|
protected String getScriptBasedFormURL(HttpMethod initmethod, String pathQuery) throws URIException {
|
|
URI initmethodURI = initmethod.getURI();
|
|
int queryIndex = pathQuery.indexOf('?');
|
|
if (queryIndex >= 0) {
|
|
if (queryIndex > 0) {
|
|
// update path
|
|
String newPath = pathQuery.substring(0, queryIndex);
|
|
if (newPath.startsWith("/")) {
|
|
// absolute path
|
|
initmethodURI.setPath(newPath);
|
|
} else {
|
|
String currentPath = initmethodURI.getPath();
|
|
int folderIndex = currentPath.lastIndexOf('/');
|
|
if (folderIndex >= 0) {
|
|
// replace relative path
|
|
initmethodURI.setPath(currentPath.substring(0, folderIndex + 1) + newPath);
|
|
} else {
|
|
// should not happen
|
|
initmethodURI.setPath('/' + newPath);
|
|
}
|
|
}
|
|
}
|
|
initmethodURI.setQuery(pathQuery.substring(queryIndex + 1));
|
|
}
|
|
return initmethodURI.getURI();
|
|
}
|
|
|
|
/**
|
|
* Try to find logon method path from logon form body.
|
|
*
|
|
* @param httpClient httpClient instance
|
|
* @param initmethod form body http method
|
|
* @return logon method
|
|
* @throws IOException on error
|
|
*/
|
|
protected PostMethod buildLogonMethod(HttpClient httpClient, HttpMethod initmethod) throws IOException {
|
|
|
|
PostMethod logonMethod = null;
|
|
|
|
// create an instance of HtmlCleaner
|
|
HtmlCleaner cleaner = new HtmlCleaner();
|
|
|
|
try {
|
|
TagNode node = cleaner.clean(initmethod.getResponseBodyAsStream());
|
|
List forms = node.getElementListByName("form", true);
|
|
TagNode logonForm = null;
|
|
// select form
|
|
if (forms.size() == 1) {
|
|
logonForm = (TagNode) forms.get(0);
|
|
} else if (forms.size() > 1) {
|
|
for (Object form : forms) {
|
|
if ("logonForm".equals(((TagNode) form).getAttributeByName("name"))) {
|
|
logonForm = ((TagNode) form);
|
|
}
|
|
}
|
|
}
|
|
if (logonForm != null) {
|
|
String logonMethodPath = logonForm.getAttributeByName("action");
|
|
|
|
logonMethod = new PostMethod(getAbsoluteUri(initmethod, logonMethodPath));
|
|
|
|
List inputList = logonForm.getElementListByName("input", true);
|
|
for (Object input : inputList) {
|
|
String type = ((TagNode) input).getAttributeByName("type");
|
|
String name = ((TagNode) input).getAttributeByName("name");
|
|
String value = ((TagNode) input).getAttributeByName("value");
|
|
if ("hidden".equalsIgnoreCase(type) && name != null && value != null) {
|
|
logonMethod.addParameter(name, value);
|
|
}
|
|
// custom login form
|
|
if (USER_NAME_FIELDS.contains(name)) {
|
|
userNameInput = name;
|
|
} else if (PASSWORD_FIELDS.contains(name)) {
|
|
passwordInput = name;
|
|
} else if ("addr".equals(name)) {
|
|
// this is not a logon form but a redirect form
|
|
HttpMethod newInitMethod = DavGatewayHttpClientFacade.executeFollowRedirects(httpClient, logonMethod);
|
|
logonMethod = buildLogonMethod(httpClient, newInitMethod);
|
|
} else if (TOKEN_FIELDS.contains(name)) {
|
|
// one time password, ask user
|
|
logonMethod.addParameter(name, DavGatewayOTPPrompt.getOneTimePassword());
|
|
}
|
|
}
|
|
} else {
|
|
List frameList = node.getElementListByName("frame", true);
|
|
if (frameList.size() == 1) {
|
|
String src = ((TagNode) frameList.get(0)).getAttributeByName("src");
|
|
if (src != null) {
|
|
LOGGER.debug("Frames detected in form page, try frame content");
|
|
initmethod.releaseConnection();
|
|
HttpMethod newInitMethod = DavGatewayHttpClientFacade.executeFollowRedirects(httpClient, src);
|
|
logonMethod = buildLogonMethod(httpClient, newInitMethod);
|
|
}
|
|
} else {
|
|
// another failover for script based logon forms (Exchange 2007)
|
|
List scriptList = node.getElementListByName("script", true);
|
|
for (Object script : scriptList) {
|
|
List contents = ((TagNode) script).getChildren();
|
|
for (Object content : contents) {
|
|
if (content instanceof CommentToken) {
|
|
String scriptValue = ((CommentToken) content).getCommentedContent();
|
|
String sUrl = StringUtil.getToken(scriptValue, "var a_sUrl = \"", "\"");
|
|
String sLgn = StringUtil.getToken(scriptValue, "var a_sLgn = \"", "\"");
|
|
if (sLgn == null) {
|
|
sLgn = StringUtil.getToken(scriptValue, "var a_sLgnQS = \"", "\"");
|
|
}
|
|
if (sUrl != null && sLgn != null) {
|
|
String src = getScriptBasedFormURL(initmethod, sLgn + sUrl);
|
|
LOGGER.debug("Detected script based logon, redirect to form at " + src);
|
|
HttpMethod newInitMethod = DavGatewayHttpClientFacade.executeFollowRedirects(httpClient, src);
|
|
logonMethod = buildLogonMethod(httpClient, newInitMethod);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} catch (IOException e) {
|
|
LOGGER.error("Error parsing login form at " + initmethod.getURI());
|
|
} finally {
|
|
initmethod.releaseConnection();
|
|
}
|
|
|
|
return logonMethod;
|
|
}
|
|
|
|
protected HttpMethod formLogin(HttpClient httpClient, HttpMethod initmethod, String userName, String password) throws IOException {
|
|
LOGGER.debug("Form based authentication detected");
|
|
|
|
HttpMethod logonMethod = buildLogonMethod(httpClient, initmethod);
|
|
if (logonMethod == null) {
|
|
throw new DavMailException("EXCEPTION_AUTHENTICATION_FORM_NOT_FOUND", initmethod.getURI());
|
|
}
|
|
|
|
// make sure username and password fields are empty
|
|
((PostMethod) logonMethod).removeParameter(userNameInput);
|
|
((PostMethod) logonMethod).removeParameter(passwordInput);
|
|
((PostMethod) logonMethod).removeParameter("trusted");
|
|
((PostMethod) logonMethod).removeParameter("flags");
|
|
((PostMethod) logonMethod).addParameter(userNameInput, userName);
|
|
((PostMethod) logonMethod).addParameter(passwordInput, password);
|
|
((PostMethod) logonMethod).addParameter("trusted", "4");
|
|
((PostMethod) logonMethod).addParameter("flags", "4");
|
|
logonMethod = DavGatewayHttpClientFacade.executeFollowRedirects(httpClient, logonMethod);
|
|
|
|
// test form based authentication
|
|
checkFormLoginQueryString(logonMethod);
|
|
|
|
// workaround for post logon script redirect
|
|
if (!isAuthenticated()) {
|
|
// try to get new method from script based redirection
|
|
logonMethod = buildLogonMethod(httpClient, logonMethod);
|
|
|
|
if (logonMethod != null) {
|
|
// if logonMethod is not null, try to follow redirection
|
|
logonMethod = DavGatewayHttpClientFacade.executeFollowRedirects(httpClient, logonMethod);
|
|
checkFormLoginQueryString(logonMethod);
|
|
// also check cookies
|
|
if (!isAuthenticated()) {
|
|
throwAuthenticationFailed();
|
|
}
|
|
} else {
|
|
// authentication failed
|
|
throwAuthenticationFailed();
|
|
}
|
|
}
|
|
|
|
return logonMethod;
|
|
}
|
|
|
|
/**
|
|
* Look for session cookies.
|
|
*
|
|
* @return true if session cookies are available
|
|
*/
|
|
protected boolean isAuthenticated() {
|
|
boolean authenticated = false;
|
|
for (Cookie cookie : httpClient.getState().getCookies()) {
|
|
// Exchange 2003 cookies
|
|
if (cookie.getName().startsWith("cadata") || "sessionid".equals(cookie.getName())
|
|
// Exchange 2007 cookie
|
|
|| "UserContext".equals(cookie.getName())) {
|
|
authenticated = true;
|
|
break;
|
|
}
|
|
}
|
|
return authenticated;
|
|
}
|
|
|
|
protected void checkFormLoginQueryString(HttpMethod logonMethod) throws DavMailAuthenticationException {
|
|
String queryString = logonMethod.getQueryString();
|
|
if (queryString != null && queryString.contains("reason=2")) {
|
|
logonMethod.releaseConnection();
|
|
throwAuthenticationFailed();
|
|
}
|
|
}
|
|
|
|
protected void throwAuthenticationFailed() throws DavMailAuthenticationException {
|
|
if (this.userName != null && this.userName.contains("\\")) {
|
|
throw new DavMailAuthenticationException("EXCEPTION_AUTHENTICATION_FAILED");
|
|
} else {
|
|
throw new DavMailAuthenticationException("EXCEPTION_AUTHENTICATION_FAILED_RETRY");
|
|
}
|
|
}
|
|
|
|
protected abstract void buildSessionInfo(HttpMethod method) throws DavMailException;
|
|
|
|
/**
|
|
* Create message in specified folder.
|
|
* Will overwrite an existing message with same subject in the same folder
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @param messageName message name
|
|
* @param properties message properties (flags)
|
|
* @param messageBody mail body
|
|
* @throws IOException when unable to create message
|
|
*/
|
|
public abstract void createMessage(String folderPath, String messageName, HashMap<String, String> properties, byte[] messageBody) throws IOException;
|
|
|
|
/**
|
|
* Update given properties on message.
|
|
*
|
|
* @param message Exchange message
|
|
* @param properties Webdav properties map
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract void updateMessage(Message message, Map<String, String> properties) throws IOException;
|
|
|
|
|
|
/**
|
|
* Delete Exchange message.
|
|
*
|
|
* @param message Exchange message
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract void deleteMessage(Message message) throws IOException;
|
|
|
|
/**
|
|
* Send message to recipients, properties contains bcc recipients and other non MIME flags.
|
|
*
|
|
* @param messageBody MIME message body
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract void sendMessage(byte[] messageBody) throws IOException;
|
|
|
|
/**
|
|
* Create message MIME body reader.
|
|
*
|
|
* @param message Exchange message
|
|
* @return message body reader
|
|
* @throws IOException on error
|
|
*/
|
|
protected abstract BufferedReader getContentReader(Message message) throws IOException;
|
|
|
|
/**
|
|
* Get raw MIME message content
|
|
*
|
|
* @param message Exchange message
|
|
* @return message body
|
|
* @throws IOException on error
|
|
*/
|
|
protected abstract byte[] getContent(Message message) throws IOException;
|
|
|
|
protected static final Set<String> POP_MESSAGE_ATTRIBUTES = new HashSet<String>();
|
|
|
|
static {
|
|
POP_MESSAGE_ATTRIBUTES.add("uid");
|
|
POP_MESSAGE_ATTRIBUTES.add("messageSize");
|
|
}
|
|
|
|
/**
|
|
* Return folder message list with id and size only (for POP3 listener).
|
|
*
|
|
* @param folderName Exchange folder name
|
|
* @return folder message list
|
|
* @throws IOException on error
|
|
*/
|
|
public MessageList getAllMessageUidAndSize(String folderName) throws IOException {
|
|
return searchMessages(folderName, POP_MESSAGE_ATTRIBUTES, null);
|
|
}
|
|
|
|
protected static final Set<String> IMAP_MESSAGE_ATTRIBUTES = new HashSet<String>();
|
|
|
|
static {
|
|
IMAP_MESSAGE_ATTRIBUTES.add("permanenturl");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("uid");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("messageSize");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("imapUid");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("junk");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("flagStatus");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("messageFlags");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("lastVerbExecuted");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("read");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("deleted");
|
|
IMAP_MESSAGE_ATTRIBUTES.add("date");
|
|
}
|
|
|
|
protected static final Set<String> UID_MESSAGE_ATTRIBUTES = new HashSet<String>();
|
|
|
|
static {
|
|
UID_MESSAGE_ATTRIBUTES.add("uid");
|
|
}
|
|
|
|
/**
|
|
* Get all folder messages.
|
|
*
|
|
* @param folderPath Exchange folder name
|
|
* @return message list
|
|
* @throws IOException on error
|
|
*/
|
|
public MessageList searchMessages(String folderPath) throws IOException {
|
|
return searchMessages(folderPath, IMAP_MESSAGE_ATTRIBUTES, null);
|
|
}
|
|
|
|
/**
|
|
* Search folder for messages matching conditions, with attributes needed by IMAP listener.
|
|
*
|
|
* @param folderName Exchange folder name
|
|
* @param condition search filter
|
|
* @return message list
|
|
* @throws IOException on error
|
|
*/
|
|
public MessageList searchMessages(String folderName, Condition condition) throws IOException {
|
|
return searchMessages(folderName, IMAP_MESSAGE_ATTRIBUTES, condition);
|
|
}
|
|
|
|
/**
|
|
* Search folder for messages matching conditions, with given attributes.
|
|
*
|
|
* @param folderName Exchange folder name
|
|
* @param attributes requested Webdav attributes
|
|
* @param condition search filter
|
|
* @return message list
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract MessageList searchMessages(String folderName, Set<String> attributes, Condition condition) throws IOException;
|
|
|
|
protected enum Operator {
|
|
Or, And, Not, IsEqualTo, IsGreaterThan, IsGreaterThanOrEqualTo, IsLessThan, IsNull, IsTrue, IsFalse,
|
|
Like, StartsWith, Contains
|
|
}
|
|
|
|
/**
|
|
* Exchange search filter.
|
|
*/
|
|
public static interface Condition {
|
|
/**
|
|
* Append condition to buffer.
|
|
*
|
|
* @param buffer search filter buffer
|
|
*/
|
|
public void appendTo(StringBuilder buffer);
|
|
|
|
/**
|
|
* True if condition is empty.
|
|
*
|
|
* @return true if condition is empty
|
|
*/
|
|
public boolean isEmpty();
|
|
}
|
|
|
|
/**
|
|
* Attribute condition.
|
|
*/
|
|
public abstract static class AttributeCondition implements Condition {
|
|
protected String attributeName;
|
|
protected Operator operator;
|
|
protected String value;
|
|
|
|
protected AttributeCondition(String attributeName, Operator operator, String value) {
|
|
this.attributeName = attributeName;
|
|
this.operator = operator;
|
|
this.value = value;
|
|
}
|
|
|
|
public boolean isEmpty() {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Multiple condition.
|
|
*/
|
|
public abstract static class MultiCondition implements Condition {
|
|
protected Operator operator;
|
|
protected List<Condition> conditions;
|
|
|
|
protected MultiCondition(Operator operator, Condition... conditions) {
|
|
this.operator = operator;
|
|
this.conditions = new ArrayList<Condition>();
|
|
for (Condition condition : conditions) {
|
|
if (condition != null) {
|
|
this.conditions.add(condition);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a new condition.
|
|
*
|
|
* @param condition single condition
|
|
*/
|
|
public void add(Condition condition) {
|
|
if (condition != null) {
|
|
conditions.add(condition);
|
|
}
|
|
}
|
|
|
|
public boolean isEmpty() {
|
|
boolean isEmpty = true;
|
|
for (Condition condition : conditions) {
|
|
if (!condition.isEmpty()) {
|
|
isEmpty = false;
|
|
break;
|
|
}
|
|
}
|
|
return isEmpty;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Not condition.
|
|
*/
|
|
public abstract static class NotCondition implements Condition {
|
|
protected Condition condition;
|
|
|
|
protected NotCondition(Condition condition) {
|
|
this.condition = condition;
|
|
}
|
|
|
|
public boolean isEmpty() {
|
|
return condition.isEmpty();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Single search filter condition.
|
|
*/
|
|
public abstract static class MonoCondition implements Condition {
|
|
protected String attributeName;
|
|
protected Operator operator;
|
|
|
|
protected MonoCondition(String attributeName, Operator operator) {
|
|
this.attributeName = attributeName;
|
|
this.operator = operator;
|
|
}
|
|
|
|
public boolean isEmpty() {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* And search filter.
|
|
*
|
|
* @param condition search conditions
|
|
* @return condition
|
|
*/
|
|
public abstract MultiCondition and(Condition... condition);
|
|
|
|
/**
|
|
* Or search filter.
|
|
*
|
|
* @param condition search conditions
|
|
* @return condition
|
|
*/
|
|
public abstract MultiCondition or(Condition... condition);
|
|
|
|
/**
|
|
* Not search filter.
|
|
*
|
|
* @param condition search condition
|
|
* @return condition
|
|
*/
|
|
public abstract Condition not(Condition condition);
|
|
|
|
/**
|
|
* Equals condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @param value attribute value
|
|
* @return condition
|
|
*/
|
|
public abstract Condition equals(String attributeName, String value);
|
|
|
|
/**
|
|
* Equals condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @param value attribute value
|
|
* @return condition
|
|
*/
|
|
public abstract Condition equals(String attributeName, int value);
|
|
|
|
/**
|
|
* MIME header equals condition.
|
|
*
|
|
* @param headerName MIME header name
|
|
* @param value attribute value
|
|
* @return condition
|
|
*/
|
|
public abstract Condition headerEquals(String headerName, String value);
|
|
|
|
/**
|
|
* Greater than or equals condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @param value attribute value
|
|
* @return condition
|
|
*/
|
|
public abstract Condition gte(String attributeName, String value);
|
|
|
|
/**
|
|
* Greater than condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @param value attribute value
|
|
* @return condition
|
|
*/
|
|
public abstract Condition gt(String attributeName, String value);
|
|
|
|
/**
|
|
* Lower than condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @param value attribute value
|
|
* @return condition
|
|
*/
|
|
public abstract Condition lt(String attributeName, String value);
|
|
|
|
/**
|
|
* Contains condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @param value attribute value
|
|
* @return condition
|
|
*/
|
|
public abstract Condition contains(String attributeName, String value);
|
|
|
|
/**
|
|
* Starts with condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @param value attribute value
|
|
* @return condition
|
|
*/
|
|
public abstract Condition startsWith(String attributeName, String value);
|
|
|
|
/**
|
|
* Is null condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @return condition
|
|
*/
|
|
public abstract Condition isNull(String attributeName);
|
|
|
|
/**
|
|
* Is true condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @return condition
|
|
*/
|
|
public abstract Condition isTrue(String attributeName);
|
|
|
|
/**
|
|
* Is false condition.
|
|
*
|
|
* @param attributeName logical Exchange attribute name
|
|
* @return condition
|
|
*/
|
|
public abstract Condition isFalse(String attributeName);
|
|
|
|
/**
|
|
* Search mail and generic folders under given folder.
|
|
* Exclude calendar and contacts folders
|
|
*
|
|
* @param folderName Exchange folder name
|
|
* @param recursive deep search if true
|
|
* @return list of folders
|
|
* @throws IOException on error
|
|
*/
|
|
public List<Folder> getSubFolders(String folderName, boolean recursive) throws IOException {
|
|
return getSubFolders(folderName, or(equals("folderclass", "IPF.Note"), isNull("folderclass")),
|
|
recursive);
|
|
}
|
|
|
|
/**
|
|
* Search calendar folders under given folder.
|
|
*
|
|
* @param folderName Exchange folder name
|
|
* @param recursive deep search if true
|
|
* @return list of folders
|
|
* @throws IOException on error
|
|
*/
|
|
public List<Folder> getSubCalendarFolders(String folderName, boolean recursive) throws IOException {
|
|
return getSubFolders(folderName, equals("folderclass", "IPF.Appointment"), recursive);
|
|
}
|
|
|
|
/**
|
|
* Search folders under given folder matching filter.
|
|
*
|
|
* @param folderName Exchange folder name
|
|
* @param condition search filter
|
|
* @param recursive deep search if true
|
|
* @return list of folders
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract List<Folder> getSubFolders(String folderName, Condition condition, boolean recursive) throws IOException;
|
|
|
|
/**
|
|
* Delete oldest messages in trash.
|
|
* keepDelay is the number of days to keep messages in trash before delete
|
|
*
|
|
* @throws IOException when unable to purge messages
|
|
*/
|
|
public void purgeOldestTrashAndSentMessages() throws IOException {
|
|
int keepDelay = Settings.getIntProperty("davmail.keepDelay");
|
|
if (keepDelay != 0) {
|
|
purgeOldestFolderMessages(TRASH, keepDelay);
|
|
}
|
|
// this is a new feature, default is : do nothing
|
|
int sentKeepDelay = Settings.getIntProperty("davmail.sentKeepDelay");
|
|
if (sentKeepDelay != 0) {
|
|
purgeOldestFolderMessages(SENT, sentKeepDelay);
|
|
}
|
|
}
|
|
|
|
protected void purgeOldestFolderMessages(String folderPath, int keepDelay) throws IOException {
|
|
Calendar cal = Calendar.getInstance();
|
|
cal.add(Calendar.DAY_OF_MONTH, -keepDelay);
|
|
LOGGER.debug("Delete messages in " + folderPath + " not modified since " + cal.getTime());
|
|
|
|
MessageList messages = searchMessages(folderPath, UID_MESSAGE_ATTRIBUTES,
|
|
lt("lastmodified", formatSearchDate(cal.getTime())));
|
|
|
|
for (Message message : messages) {
|
|
message.delete();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Send message in reader to recipients.
|
|
* Detect visible recipients in message body to determine bcc recipients
|
|
*
|
|
* @param rcptToRecipients recipients list
|
|
* @param mimeMessage mime message
|
|
* @throws IOException on error
|
|
* @throws MessagingException on error
|
|
*/
|
|
public void sendMessage(List<String> rcptToRecipients, MimeMessage mimeMessage) throws IOException, MessagingException {
|
|
// Exchange 2007 : skip From: header
|
|
mimeMessage.removeHeader("from");
|
|
|
|
// remove visible recipients from list
|
|
Set<String> visibleRecipients = new HashSet<String>();
|
|
Address[] recipients = mimeMessage.getAllRecipients();
|
|
for (Address address : recipients) {
|
|
visibleRecipients.add(address.toString());
|
|
}
|
|
for (String recipient : rcptToRecipients) {
|
|
if (!visibleRecipients.contains(recipient)) {
|
|
mimeMessage.addRecipient(javax.mail.Message.RecipientType.BCC, new InternetAddress(recipient));
|
|
}
|
|
}
|
|
ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
|
mimeMessage.writeTo(baos);
|
|
|
|
sendMessage(baos.toByteArray());
|
|
}
|
|
|
|
/**
|
|
* Get folder object.
|
|
* Folder name can be logical names INBOX, Drafts, Trash or calendar,
|
|
* or a path relative to user base folder or absolute path.
|
|
*
|
|
* @param folderName folder name
|
|
* @return Folder object
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract Folder getFolder(String folderName) throws IOException;
|
|
|
|
/**
|
|
* Check folder ctag and reload messages as needed.
|
|
*
|
|
* @param currentFolder current folder
|
|
* @return true if folder changed
|
|
* @throws IOException on error
|
|
*/
|
|
public boolean refreshFolder(Folder currentFolder) throws IOException {
|
|
Folder newFolder = getFolder(currentFolder.folderPath);
|
|
if (currentFolder.ctag == null || !currentFolder.ctag.equals(newFolder.ctag)) {
|
|
if (LOGGER.isDebugEnabled()) {
|
|
LOGGER.debug("Contenttag changed on " + currentFolder.folderPath + ' '
|
|
+ currentFolder.ctag + " => " + newFolder.ctag + ", reloading messages");
|
|
}
|
|
currentFolder.hasChildren = newFolder.hasChildren;
|
|
currentFolder.noInferiors = newFolder.noInferiors;
|
|
currentFolder.unreadCount = newFolder.unreadCount;
|
|
currentFolder.ctag = newFolder.ctag;
|
|
currentFolder.etag = newFolder.etag;
|
|
currentFolder.loadMessages();
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create Exchange message folder.
|
|
*
|
|
* @param folderName logical folder name
|
|
* @throws IOException on error
|
|
*/
|
|
public void createMessageFolder(String folderName) throws IOException {
|
|
createFolder(folderName, "IPF.Note");
|
|
}
|
|
|
|
/**
|
|
* Create Exchange calendar folder.
|
|
*
|
|
* @param folderName logical folder name
|
|
* @throws IOException on error
|
|
*/
|
|
public void createCalendarFolder(String folderName) throws IOException {
|
|
createFolder(folderName, "IPF.Appointment");
|
|
}
|
|
|
|
/**
|
|
* Create Exchange contact folder.
|
|
*
|
|
* @param folderName logical folder name
|
|
* @throws IOException on error
|
|
*/
|
|
public void createContactFolder(String folderName) throws IOException {
|
|
createFolder(folderName, "IPF.Contact");
|
|
}
|
|
|
|
/**
|
|
* Create Exchange folder with given folder class.
|
|
*
|
|
* @param folderName logical folder name
|
|
* @param folderClass folder class
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract void createFolder(String folderName, String folderClass) throws IOException;
|
|
|
|
/**
|
|
* Delete Exchange folder.
|
|
*
|
|
* @param folderName logical folder name
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract void deleteFolder(String folderName) throws IOException;
|
|
|
|
/**
|
|
* Copy message to target folder
|
|
*
|
|
* @param message Exchange message
|
|
* @param targetFolder target folder
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract void copyMessage(Message message, String targetFolder) throws IOException;
|
|
|
|
/**
|
|
* Move folder to target name.
|
|
*
|
|
* @param folderName current folder name/path
|
|
* @param targetName target folder name/path
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract void moveFolder(String folderName, String targetName) throws IOException;
|
|
|
|
protected abstract void moveToTrash(Message message) throws IOException;
|
|
|
|
/**
|
|
* Exchange folder with IMAP properties
|
|
*/
|
|
public class Folder {
|
|
/**
|
|
* Logical (IMAP) folder path.
|
|
*/
|
|
public String folderPath;
|
|
|
|
/**
|
|
* Display Name.
|
|
*/
|
|
public String displayName;
|
|
/**
|
|
* Folder class (PR_CONTAINER_CLASS).
|
|
*/
|
|
public String folderClass;
|
|
/**
|
|
* Folder unread message count.
|
|
*/
|
|
public int unreadCount;
|
|
/**
|
|
* true if folder has subfolders (DAV:hassubs).
|
|
*/
|
|
public boolean hasChildren;
|
|
/**
|
|
* true if folder has no subfolders (DAV:nosubs).
|
|
*/
|
|
public boolean noInferiors;
|
|
/**
|
|
* Folder content tag (to detect folder content changes).
|
|
*/
|
|
public String ctag;
|
|
/**
|
|
* Folder etag (to detect folder object changes).
|
|
*/
|
|
public String etag;
|
|
/**
|
|
* Folder message list, empty before loadMessages call.
|
|
*/
|
|
public ExchangeSession.MessageList messages;
|
|
/**
|
|
* Permanent uid (PR_SEARCH_KEY) to IMAP UID map.
|
|
*/
|
|
private final HashMap<String, Long> permanentUrlToImapUidMap = new HashMap<String, Long>();
|
|
|
|
/**
|
|
* Get IMAP folder flags.
|
|
*
|
|
* @return folder flags in IMAP format
|
|
*/
|
|
public String getFlags() {
|
|
if (noInferiors) {
|
|
return "\\NoInferiors";
|
|
} else if (hasChildren) {
|
|
return "\\HasChildren";
|
|
} else {
|
|
return "\\HasNoChildren";
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load folder messages.
|
|
*
|
|
* @throws IOException on error
|
|
*/
|
|
public void loadMessages() throws IOException {
|
|
messages = ExchangeSession.this.searchMessages(folderPath, null);
|
|
fixUids(messages);
|
|
}
|
|
|
|
/**
|
|
* Search messages in folder matching query.
|
|
*
|
|
* @param condition search query
|
|
* @return message list
|
|
* @throws IOException on error
|
|
*/
|
|
public MessageList searchMessages(Condition condition) throws IOException {
|
|
MessageList localMessages = ExchangeSession.this.searchMessages(folderPath, condition);
|
|
fixUids(localMessages);
|
|
return localMessages;
|
|
}
|
|
|
|
/**
|
|
* Restore previous uids changed by a PROPPATCH (flag change).
|
|
*
|
|
* @param messages message list
|
|
*/
|
|
protected void fixUids(MessageList messages) {
|
|
boolean sortNeeded = false;
|
|
for (Message message : messages) {
|
|
if (permanentUrlToImapUidMap.containsKey(message.permanentUrl)) {
|
|
long previousUid = permanentUrlToImapUidMap.get(message.permanentUrl);
|
|
if (message.getImapUid() != previousUid) {
|
|
LOGGER.debug("Restoring IMAP uid " + message.getImapUid() + " -> " + previousUid + " for message " + message.permanentUrl);
|
|
message.setImapUid(previousUid);
|
|
sortNeeded = true;
|
|
}
|
|
} else {
|
|
// add message to uid map
|
|
permanentUrlToImapUidMap.put(message.permanentUrl, message.getImapUid());
|
|
}
|
|
}
|
|
if (sortNeeded) {
|
|
Collections.sort(messages);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Folder message count.
|
|
*
|
|
* @return message count
|
|
*/
|
|
public int count() {
|
|
return messages.size();
|
|
}
|
|
|
|
/**
|
|
* Compute IMAP uidnext.
|
|
*
|
|
* @return max(messageuids)+1
|
|
*/
|
|
public long getUidNext() {
|
|
return messages.get(messages.size() - 1).getImapUid() + 1;
|
|
}
|
|
|
|
/**
|
|
* Get message at index.
|
|
*
|
|
* @param index message index
|
|
* @return message
|
|
*/
|
|
public Message get(int index) {
|
|
return messages.get(index);
|
|
}
|
|
|
|
/**
|
|
* Get current folder messages imap uids
|
|
*
|
|
* @return imap uid list
|
|
*/
|
|
public List<Long> getImapUidList() {
|
|
ArrayList<Long> imapUidList = new ArrayList<Long>();
|
|
for (ExchangeSession.Message message : messages) {
|
|
imapUidList.add(message.getImapUid());
|
|
}
|
|
return imapUidList;
|
|
}
|
|
|
|
/**
|
|
* Calendar folder flag.
|
|
*
|
|
* @return true if this is a calendar folder
|
|
*/
|
|
public boolean isCalendar() {
|
|
return "IPF.Appointment".equals(folderClass);
|
|
}
|
|
|
|
/**
|
|
* Contact folder flag.
|
|
*
|
|
* @return true if this is a calendar folder
|
|
*/
|
|
public boolean isContact() {
|
|
return "IPF.Contact".equals(folderClass);
|
|
}
|
|
|
|
/**
|
|
* drop cached message
|
|
*/
|
|
public void clearCache() {
|
|
messages.cachedMimeBody = null;
|
|
messages.cachedMimeMessage = null;
|
|
messages.cachedMessageImapUid = 0;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Exchange message.
|
|
*/
|
|
public class Message implements Comparable<Message> {
|
|
/**
|
|
* enclosing message list
|
|
*/
|
|
public MessageList messageList;
|
|
/**
|
|
* Message url.
|
|
*/
|
|
public String messageUrl;
|
|
/**
|
|
* Message permanent url (does not change on message move).
|
|
*/
|
|
public String permanentUrl;
|
|
/**
|
|
* Message uid.
|
|
*/
|
|
public String uid;
|
|
/**
|
|
* Message IMAP uid, unique in folder (x0e230003).
|
|
*/
|
|
public long imapUid;
|
|
/**
|
|
* MAPI message size.
|
|
*/
|
|
public int size;
|
|
/**
|
|
* Message date (urn:schemas:mailheader:date).
|
|
*/
|
|
public String date;
|
|
|
|
/**
|
|
* Message flag: read.
|
|
*/
|
|
public boolean read;
|
|
/**
|
|
* Message flag: deleted.
|
|
*/
|
|
public boolean deleted;
|
|
/**
|
|
* Message flag: junk.
|
|
*/
|
|
public boolean junk;
|
|
/**
|
|
* Message flag: flagged.
|
|
*/
|
|
public boolean flagged;
|
|
/**
|
|
* Message flag: draft.
|
|
*/
|
|
public boolean draft;
|
|
/**
|
|
* Message flag: answered.
|
|
*/
|
|
public boolean answered;
|
|
/**
|
|
* Message flag: fowarded.
|
|
*/
|
|
public boolean forwarded;
|
|
|
|
/**
|
|
* Unparsed message content.
|
|
*/
|
|
protected SharedByteArrayInputStream mimeBody;
|
|
|
|
/**
|
|
* Message content parsed in a MIME message.
|
|
*/
|
|
protected MimeMessage mimeMessage;
|
|
|
|
/**
|
|
* IMAP uid , unique in folder (x0e230003)
|
|
*
|
|
* @return IMAP uid
|
|
*/
|
|
public long getImapUid() {
|
|
return imapUid;
|
|
}
|
|
|
|
/**
|
|
* Set IMAP uid.
|
|
*
|
|
* @param imapUid new uid
|
|
*/
|
|
public void setImapUid(long imapUid) {
|
|
this.imapUid = imapUid;
|
|
}
|
|
|
|
/**
|
|
* Exchange uid.
|
|
*
|
|
* @return uid
|
|
*/
|
|
public String getUid() {
|
|
return uid;
|
|
}
|
|
|
|
/**
|
|
* Return permanent message url.
|
|
*
|
|
* @return permanent message url
|
|
*/
|
|
public String getPermanentUrl() {
|
|
return permanentUrl;
|
|
}
|
|
|
|
/**
|
|
* Return message flags in IMAP format.
|
|
*
|
|
* @return IMAP flags
|
|
*/
|
|
public String getImapFlags() {
|
|
StringBuilder buffer = new StringBuilder();
|
|
if (read) {
|
|
buffer.append("\\Seen ");
|
|
}
|
|
if (deleted) {
|
|
buffer.append("\\Deleted ");
|
|
}
|
|
if (flagged) {
|
|
buffer.append("\\Flagged ");
|
|
}
|
|
if (junk) {
|
|
buffer.append("Junk ");
|
|
}
|
|
if (draft) {
|
|
buffer.append("\\Draft ");
|
|
}
|
|
if (answered) {
|
|
buffer.append("\\Answered ");
|
|
}
|
|
if (forwarded) {
|
|
buffer.append("$Forwarded ");
|
|
}
|
|
return buffer.toString().trim();
|
|
}
|
|
|
|
/**
|
|
* Write MIME message to os
|
|
*
|
|
* @param os output stream
|
|
* @param doubleDot replace '.' lines with '..' (POP protocol)
|
|
* @throws IOException on error
|
|
* @deprecated move to byte array handling instead
|
|
*/
|
|
@Deprecated
|
|
public void write(OutputStream os, boolean doubleDot) throws IOException {
|
|
BufferedReader reader = getContentReader(this);
|
|
try {
|
|
OutputStreamWriter isoWriter = new OutputStreamWriter(os);
|
|
String line;
|
|
while ((line = reader.readLine()) != null) {
|
|
if (doubleDot && ".".equals(line)) {
|
|
line = "..";
|
|
// patch text/calendar to include utf-8 encoding
|
|
} else if ("Content-Type: text/calendar;".equals(line)) {
|
|
StringBuilder headerBuffer = new StringBuilder();
|
|
headerBuffer.append(line);
|
|
while ((line = reader.readLine()) != null && line.startsWith("\t")) {
|
|
headerBuffer.append((char) 13);
|
|
headerBuffer.append((char) 10);
|
|
headerBuffer.append(line);
|
|
}
|
|
if (headerBuffer.indexOf("charset") < 0) {
|
|
headerBuffer.append(";charset=utf-8");
|
|
}
|
|
headerBuffer.append((char) 13);
|
|
headerBuffer.append((char) 10);
|
|
headerBuffer.append(line);
|
|
line = headerBuffer.toString();
|
|
}
|
|
isoWriter.write(line);
|
|
isoWriter.write((char) 13);
|
|
isoWriter.write((char) 10);
|
|
}
|
|
isoWriter.flush();
|
|
} finally {
|
|
try {
|
|
reader.close();
|
|
} catch (IOException e) {
|
|
LOGGER.warn("Error closing message input stream", e);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load message content in a Mime message
|
|
*
|
|
* @throws IOException on error
|
|
* @throws MessagingException on error
|
|
*/
|
|
protected void loadMimeMessage() throws IOException, MessagingException {
|
|
if (mimeMessage == null) {
|
|
// try to get message content from cache
|
|
if (this.imapUid == messageList.cachedMessageImapUid) {
|
|
mimeBody = messageList.cachedMimeBody;
|
|
mimeMessage = messageList.cachedMimeMessage;
|
|
LOGGER.debug("Got message content for " + imapUid + " from cache");
|
|
} else {
|
|
// load and parse message
|
|
mimeBody = new SharedByteArrayInputStream(getContent(this));
|
|
mimeMessage = new MimeMessage(null, mimeBody);
|
|
LOGGER.debug("Downloaded message content for " + imapUid + " (" + mimeBody.available() + ')');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get message content as a Mime message.
|
|
*
|
|
* @return mime message
|
|
* @throws IOException on error
|
|
* @throws MessagingException on error
|
|
*/
|
|
public MimeMessage getMimeMessage() throws IOException, MessagingException {
|
|
loadMimeMessage();
|
|
return mimeMessage;
|
|
}
|
|
|
|
/**
|
|
* Get message body size.
|
|
*
|
|
* @return mime message size
|
|
* @throws IOException on error
|
|
* @throws MessagingException on error
|
|
*/
|
|
public int getMimeMessageSize() throws IOException, MessagingException {
|
|
loadMimeMessage();
|
|
mimeBody.reset();
|
|
return mimeBody.available();
|
|
}
|
|
|
|
/**
|
|
* Get message body input stream.
|
|
*
|
|
* @return mime message InputStream
|
|
* @throws IOException on error
|
|
* @throws MessagingException on error
|
|
*/
|
|
public InputStream getRawInputStream() throws IOException, MessagingException {
|
|
loadMimeMessage();
|
|
mimeBody.reset();
|
|
return mimeBody;
|
|
}
|
|
|
|
|
|
/**
|
|
* Drop mime message to avoid keeping message content in memory,
|
|
* keep a single message in MessageList cache to handle chunked fetch.
|
|
*/
|
|
public void dropMimeMessage() {
|
|
// update single message cache
|
|
if (mimeMessage != null) {
|
|
messageList.cachedMessageImapUid = imapUid;
|
|
messageList.cachedMimeBody = mimeBody;
|
|
messageList.cachedMimeMessage = mimeMessage;
|
|
}
|
|
mimeMessage = null;
|
|
}
|
|
|
|
/**
|
|
* Delete message.
|
|
*
|
|
* @throws IOException on error
|
|
*/
|
|
public void delete() throws IOException {
|
|
LOGGER.debug("Delete " + permanentUrl + " (" + messageUrl + ')');
|
|
deleteMessage(this);
|
|
}
|
|
|
|
/**
|
|
* Move message to trash, mark message read.
|
|
*
|
|
* @throws IOException on error
|
|
*/
|
|
public void moveToTrash() throws IOException {
|
|
// mark message as read
|
|
HashMap<String, String> properties = new HashMap<String, String>();
|
|
properties.put("read", "1");
|
|
updateMessage(this, properties);
|
|
|
|
ExchangeSession.this.moveToTrash(this);
|
|
}
|
|
|
|
/**
|
|
* Comparator to sort messages by IMAP uid
|
|
*
|
|
* @param message other message
|
|
* @return imapUid comparison result
|
|
*/
|
|
public int compareTo(Message message) {
|
|
long compareValue = (imapUid - message.imapUid);
|
|
if (compareValue > 0) {
|
|
return 1;
|
|
} else if (compareValue < 0) {
|
|
return -1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Override equals, compare IMAP uids
|
|
*
|
|
* @param message other message
|
|
* @return true if IMAP uids are equal
|
|
*/
|
|
@Override
|
|
public boolean equals(Object message) {
|
|
return message instanceof Message && imapUid == ((Message) message).imapUid;
|
|
}
|
|
|
|
/**
|
|
* Override hashCode, return imapUid hashcode.
|
|
*
|
|
* @return imapUid hashcode
|
|
*/
|
|
@Override
|
|
public int hashCode() {
|
|
return (int) (imapUid ^ (imapUid >>> 32));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Message list, includes a single messsage cache
|
|
*/
|
|
public static class MessageList extends ArrayList<Message> {
|
|
/**
|
|
* Cached message content parsed in a MIME message.
|
|
*/
|
|
protected transient MimeMessage cachedMimeMessage;
|
|
/**
|
|
* Cached message uid.
|
|
*/
|
|
protected transient long cachedMessageImapUid;
|
|
/**
|
|
* Cached unparsed message
|
|
*/
|
|
protected transient SharedByteArrayInputStream cachedMimeBody;
|
|
|
|
}
|
|
|
|
/**
|
|
* Generic folder item.
|
|
*/
|
|
public abstract static class Item extends HashMap<String, String> {
|
|
protected String folderPath;
|
|
protected String itemName;
|
|
protected String permanentUrl;
|
|
/**
|
|
* Display name.
|
|
*/
|
|
public String displayName;
|
|
/**
|
|
* item etag
|
|
*/
|
|
public String etag;
|
|
protected String noneMatch;
|
|
|
|
/**
|
|
* Build item instance.
|
|
*
|
|
* @param folderPath folder path
|
|
* @param itemName item name class
|
|
* @param etag item etag
|
|
* @param noneMatch none match flag
|
|
*/
|
|
public Item(String folderPath, String itemName, String etag, String noneMatch) {
|
|
this.folderPath = folderPath;
|
|
this.itemName = itemName;
|
|
this.etag = etag;
|
|
this.noneMatch = noneMatch;
|
|
}
|
|
|
|
/**
|
|
* Default constructor.
|
|
*/
|
|
protected Item() {
|
|
}
|
|
|
|
/**
|
|
* Return item content type
|
|
*
|
|
* @return content type
|
|
*/
|
|
public abstract String getContentType();
|
|
|
|
/**
|
|
* Retrieve item body from Exchange
|
|
*
|
|
* @return item body
|
|
* @throws HttpException on error
|
|
*/
|
|
public abstract String getBody() throws HttpException;
|
|
|
|
/**
|
|
* Get event name (file name part in URL).
|
|
*
|
|
* @return event name
|
|
*/
|
|
public String getName() {
|
|
return itemName;
|
|
}
|
|
|
|
/**
|
|
* Get event etag (last change tag).
|
|
*
|
|
* @return event etag
|
|
*/
|
|
public String getEtag() {
|
|
return etag;
|
|
}
|
|
|
|
protected HttpException buildHttpException(Exception e) {
|
|
String message = "Unable to get event " + getName() + " at " + permanentUrl + ": " + e.getMessage();
|
|
LOGGER.warn(message);
|
|
return new HttpException(message);
|
|
}
|
|
|
|
/**
|
|
* Set item href.
|
|
*
|
|
* @param href item href
|
|
*/
|
|
public void setHref(String href) {
|
|
int index = href.lastIndexOf('/');
|
|
if (index >= 0) {
|
|
folderPath = href.substring(0, index);
|
|
itemName = href.substring(index + 1);
|
|
} else {
|
|
throw new IllegalArgumentException(href);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return item href.
|
|
*
|
|
* @return item href
|
|
*/
|
|
public String getHref() {
|
|
return folderPath + '/' + itemName;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Contact object
|
|
*/
|
|
public abstract class Contact extends Item {
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public Contact(String folderPath, String itemName, Map<String, String> properties, String etag, String noneMatch) {
|
|
super(folderPath, itemName.endsWith(".vcf") ? itemName.substring(0, itemName.length() - 3) + "EML" : itemName, etag, noneMatch);
|
|
this.putAll(properties);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
protected Contact() {
|
|
}
|
|
|
|
/**
|
|
* Convert EML extension to vcf.
|
|
*
|
|
* @return item name
|
|
*/
|
|
@Override
|
|
public String getName() {
|
|
String name = super.getName();
|
|
if (name.endsWith(".EML")) {
|
|
name = name.substring(0, name.length() - 3) + "vcf";
|
|
}
|
|
return name;
|
|
}
|
|
|
|
/**
|
|
* Compute vcard uid from name.
|
|
*
|
|
* @return uid
|
|
* @throws URIException on error
|
|
*/
|
|
protected String getUid() throws URIException {
|
|
String uid = getName();
|
|
int dotIndex = uid.lastIndexOf('.');
|
|
if (dotIndex > 0) {
|
|
uid = uid.substring(0, dotIndex);
|
|
}
|
|
return URIUtil.encodePath(uid);
|
|
}
|
|
|
|
@Override
|
|
public String getContentType() {
|
|
return "text/vcard";
|
|
}
|
|
|
|
|
|
@Override
|
|
public String getBody() throws HttpException {
|
|
// build RFC 2426 VCard from contact information
|
|
VCardWriter writer = new VCardWriter();
|
|
writer.startCard();
|
|
writer.appendProperty("UID", getUid());
|
|
// common name
|
|
writer.appendProperty("FN", get("cn"));
|
|
// RFC 2426: Family Name, Given Name, Additional Names, Honorific Prefixes, and Honorific Suffixes
|
|
writer.appendProperty("N", get("sn"), get("givenName"), get("middlename"), get("personaltitle"), get("namesuffix"));
|
|
|
|
writer.appendProperty("TEL;TYPE=cell", get("mobile"));
|
|
writer.appendProperty("TEL;TYPE=work", get("telephoneNumber"));
|
|
writer.appendProperty("TEL;TYPE=home", get("homePhone"));
|
|
writer.appendProperty("TEL;TYPE=fax", get("facsimiletelephonenumber"));
|
|
writer.appendProperty("TEL;TYPE=pager", get("pager"));
|
|
|
|
// The structured type value corresponds, in sequence, to the post office box; the extended address;
|
|
// the street address; the locality (e.g., city); the region (e.g., state or province);
|
|
// the postal code; the country name
|
|
writer.appendProperty("ADR;TYPE=home",
|
|
get("homepostofficebox"), null, get("homeStreet"), get("homeCity"), get("homeState"), get("homePostalCode"), get("homeCountry"));
|
|
writer.appendProperty("ADR;TYPE=work",
|
|
get("postofficebox"), get("roomnumber"), get("street"), get("l"), get("st"), get("postalcode"), get("co"));
|
|
writer.appendProperty("ADR;TYPE=other",
|
|
get("otherpostofficebox"), null, get("otherstreet"), get("othercity"), get("otherstate"), get("otherpostalcode"), get("othercountry"));
|
|
|
|
writer.appendProperty("EMAIL;TYPE=work", get("email1"));
|
|
writer.appendProperty("EMAIL;TYPE=home", get("email2"));
|
|
writer.appendProperty("EMAIL;TYPE=other", get("email3"));
|
|
|
|
writer.appendProperty("ORG", get("o"), get("department"));
|
|
writer.appendProperty("URL;TYPE=work", get("businesshomepage"));
|
|
writer.appendProperty("TITLE", get("title"));
|
|
writer.appendProperty("NOTE", get("description"));
|
|
|
|
writer.appendProperty("CUSTOM1", get("extensionattribute1"));
|
|
writer.appendProperty("CUSTOM2", get("extensionattribute2"));
|
|
writer.appendProperty("CUSTOM3", get("extensionattribute3"));
|
|
writer.appendProperty("CUSTOM4", get("extensionattribute4"));
|
|
|
|
writer.appendProperty("ROLE", get("profession"));
|
|
writer.appendProperty("NICKNAME", get("nickname"));
|
|
writer.appendProperty("X-AIM", get("im"));
|
|
|
|
writer.appendProperty("BDAY", get("bday"));
|
|
|
|
writer.appendProperty("CATEGORIES", get("keywords"));
|
|
|
|
if ("1".equals(get("private"))) {
|
|
writer.appendProperty("CLASS", "PRIVATE");
|
|
}
|
|
|
|
writer.appendProperty("X-ASSISTANT", get("secretarycn"));
|
|
writer.appendProperty("X-MANAGER", get("manager"));
|
|
writer.appendProperty("X-SPOUSE", get("spousecn"));
|
|
|
|
writer.appendProperty("REV", get("lastmodified"));
|
|
|
|
if ("1".equals(get("haspicture"))) {
|
|
try {
|
|
ContactPhoto contactPhoto = getContactPhoto(this);
|
|
writer.appendProperty("PHOTO;TYPE=\"" + contactPhoto.contentType + "\";ENCODING=\"b\"", contactPhoto.content);
|
|
} catch (IOException e) {
|
|
LOGGER.warn("Unable to get photo from contact " + this.get("cn"));
|
|
}
|
|
}
|
|
|
|
writer.endCard();
|
|
return writer.toString();
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Calendar event object.
|
|
*/
|
|
public abstract class Event extends Item {
|
|
protected String contentClass;
|
|
protected String itemBody;
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public Event(String folderPath, String itemName, String contentClass, String itemBody, String etag, String noneMatch) {
|
|
super(folderPath, itemName, etag, noneMatch);
|
|
this.contentClass = contentClass;
|
|
this.itemBody = itemBody;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
protected Event() {
|
|
}
|
|
|
|
@Override
|
|
public String getContentType() {
|
|
return "text/calendar;charset=UTF-8";
|
|
}
|
|
|
|
/**
|
|
* Load ICS content from MIME message input stream
|
|
*
|
|
* @param mimeInputStream mime message input stream
|
|
* @return mime message ics attachment body
|
|
* @throws IOException on error
|
|
* @throws MessagingException on error
|
|
*/
|
|
protected String getICS(InputStream mimeInputStream) throws IOException, MessagingException {
|
|
String result;
|
|
MimeMessage mimeMessage = new MimeMessage(null, mimeInputStream);
|
|
Object mimeBody = mimeMessage.getContent();
|
|
MimePart bodyPart = null;
|
|
if (mimeBody instanceof MimeMultipart) {
|
|
bodyPart = getCalendarMimePart((MimeMultipart) mimeBody);
|
|
} else if (isCalendarContentType(mimeMessage.getContentType())) {
|
|
// no multipart, single body
|
|
bodyPart = mimeMessage;
|
|
}
|
|
|
|
if (bodyPart != null) {
|
|
ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
|
bodyPart.getDataHandler().writeTo(baos);
|
|
baos.close();
|
|
result = fixICS(new String(baos.toByteArray(), "UTF-8"), true);
|
|
} else {
|
|
ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
|
mimeMessage.writeTo(baos);
|
|
baos.close();
|
|
throw new DavMailException("EXCEPTION_INVALID_MESSAGE_CONTENT", new String(baos.toByteArray(), "UTF-8"));
|
|
}
|
|
return result;
|
|
}
|
|
|
|
protected static final String TEXT_CALENDAR = "text/calendar";
|
|
protected static final String APPLICATION_ICS = "application/ics";
|
|
|
|
protected boolean isCalendarContentType(String contentType) {
|
|
return TEXT_CALENDAR.regionMatches(true, 0, contentType, 0, TEXT_CALENDAR.length()) ||
|
|
APPLICATION_ICS.regionMatches(true, 0, contentType, 0, APPLICATION_ICS.length());
|
|
}
|
|
|
|
protected MimePart getCalendarMimePart(MimeMultipart multiPart) throws IOException, MessagingException {
|
|
MimePart bodyPart = null;
|
|
for (int i = 0; i < multiPart.getCount(); i++) {
|
|
String contentType = multiPart.getBodyPart(i).getContentType();
|
|
if (isCalendarContentType(contentType)) {
|
|
bodyPart = (MimePart) multiPart.getBodyPart(i);
|
|
break;
|
|
} else if (contentType.startsWith("multipart")) {
|
|
Object content = multiPart.getBodyPart(i).getContent();
|
|
if (content instanceof MimeMultipart) {
|
|
bodyPart = getCalendarMimePart((MimeMultipart) content);
|
|
}
|
|
}
|
|
}
|
|
|
|
return bodyPart;
|
|
}
|
|
|
|
protected String fixTimezoneId(String line, String validTimezoneId) {
|
|
return StringUtil.replaceToken(line, "TZID=", ":", validTimezoneId);
|
|
}
|
|
|
|
protected void splitExDate(ICSBufferedWriter result, String line) {
|
|
int cur = line.lastIndexOf(':') + 1;
|
|
String start = line.substring(0, cur);
|
|
|
|
for (int next = line.indexOf(',', cur); next != -1; next = line.indexOf(',', cur)) {
|
|
String val = line.substring(cur, next);
|
|
result.writeLine(start + val);
|
|
|
|
cur = next + 1;
|
|
}
|
|
|
|
result.writeLine(start + line.substring(cur));
|
|
}
|
|
|
|
protected String getAllDayLine(String line) throws IOException {
|
|
int valueIndex = line.lastIndexOf(':');
|
|
int valueEndIndex = line.lastIndexOf('T');
|
|
if (valueIndex < 0 || valueEndIndex < 0) {
|
|
throw new DavMailException("EXCEPTION_INVALID_ICS_LINE", line);
|
|
}
|
|
int keyIndex = line.indexOf(';');
|
|
if (keyIndex == -1) {
|
|
keyIndex = valueIndex;
|
|
}
|
|
String dateValue = line.substring(valueIndex + 1, valueEndIndex);
|
|
String key = line.substring(0, Math.min(keyIndex, valueIndex));
|
|
return key + ";VALUE=DATE:" + dateValue;
|
|
}
|
|
|
|
protected String fixICS(String icsBody, boolean fromServer) throws IOException {
|
|
// first pass : detect
|
|
class AllDayState {
|
|
boolean isAllDay;
|
|
boolean hasCdoAllDay;
|
|
boolean isCdoAllDay;
|
|
}
|
|
|
|
dumpIndex++;
|
|
dumpICS(icsBody, fromServer, false);
|
|
|
|
// Convert event class from and to iCal
|
|
// See https://trac.calendarserver.org/browser/CalendarServer/trunk/doc/Extensions/caldav-privateevents.txt
|
|
boolean isAppleiCal = false;
|
|
boolean hasAttendee = false;
|
|
boolean hasCdoBusyStatus = false;
|
|
// detect ics event with empty timezone (all day from Lightning)
|
|
boolean hasTimezone = false;
|
|
String transp = null;
|
|
String validTimezoneId = null;
|
|
String eventClass = null;
|
|
String organizer = null;
|
|
String action = null;
|
|
String method = null;
|
|
boolean sound = false;
|
|
|
|
List<AllDayState> allDayStates = new ArrayList<AllDayState>();
|
|
AllDayState currentAllDayState = new AllDayState();
|
|
BufferedReader reader = null;
|
|
try {
|
|
reader = new ICSBufferedReader(new StringReader(icsBody));
|
|
String line;
|
|
while ((line = reader.readLine()) != null) {
|
|
int index = line.indexOf(':');
|
|
if (index >= 0) {
|
|
String key = line.substring(0, index);
|
|
String value = line.substring(index + 1);
|
|
if ("DTSTART;VALUE=DATE".equals(key)) {
|
|
currentAllDayState.isAllDay = true;
|
|
} else if ("X-MICROSOFT-CDO-ALLDAYEVENT".equals(key)) {
|
|
currentAllDayState.hasCdoAllDay = true;
|
|
currentAllDayState.isCdoAllDay = "TRUE".equals(value);
|
|
} else if ("END:VEVENT".equals(line)) {
|
|
allDayStates.add(currentAllDayState);
|
|
currentAllDayState = new AllDayState();
|
|
} else if ("PRODID".equals(key) && line.contains("iCal")) {
|
|
// detect iCal created events
|
|
isAppleiCal = true;
|
|
} else if (isAppleiCal && "X-CALENDARSERVER-ACCESS".equals(key)) {
|
|
eventClass = value;
|
|
} else if (!isAppleiCal && "CLASS".equals(key)) {
|
|
eventClass = value;
|
|
} else if ("ACTION".equals(key)) {
|
|
action = value;
|
|
} else if ("ATTACH;VALUES=URI".equals(key)) {
|
|
// This is a marker that this event has an alarm with sound
|
|
sound = true;
|
|
} else if (key.startsWith("ORGANIZER")) {
|
|
if (value.startsWith("MAILTO:")) {
|
|
organizer = value.substring(7);
|
|
} else {
|
|
organizer = value;
|
|
}
|
|
} else if (key.startsWith("ATTENDEE")) {
|
|
hasAttendee = true;
|
|
} else if ("TRANSP".equals(key)) {
|
|
transp = value;
|
|
} else if (line.startsWith("TZID:(GMT") ||
|
|
// additional test for Outlook created recurring events
|
|
line.startsWith("TZID:GMT ")) {
|
|
try {
|
|
validTimezoneId = ResourceBundle.getBundle("timezones").getString(value);
|
|
} catch (MissingResourceException mre) {
|
|
LOGGER.warn(new BundleMessage("LOG_INVALID_TIMEZONE", value));
|
|
}
|
|
} else if ("X-MICROSOFT-CDO-BUSYSTATUS".equals(key)) {
|
|
hasCdoBusyStatus = true;
|
|
} else if ("BEGIN:VTIMEZONE".equals(line)) {
|
|
hasTimezone = true;
|
|
} else if ("METHOD".equals(key)) {
|
|
method = value;
|
|
}
|
|
}
|
|
}
|
|
} finally {
|
|
if (reader != null) {
|
|
reader.close();
|
|
}
|
|
}
|
|
// second pass : fix
|
|
int count = 0;
|
|
ICSBufferedWriter result = new ICSBufferedWriter();
|
|
try {
|
|
reader = new ICSBufferedReader(new StringReader(icsBody));
|
|
String line;
|
|
|
|
while ((line = reader.readLine()) != null) {
|
|
// remove empty properties
|
|
if ("CLASS:".equals(line) || "LOCATION:".equals(line)) {
|
|
continue;
|
|
}
|
|
// fix invalid exchange timezoneid
|
|
if (validTimezoneId != null && line.indexOf(";TZID=") >= 0) {
|
|
line = fixTimezoneId(line, validTimezoneId);
|
|
}
|
|
if (!fromServer && "BEGIN:VCALENDAR".equals(line) && method == null) {
|
|
result.writeLine(line);
|
|
// append missing method
|
|
if (method == null) {
|
|
result.writeLine("METHOD:PUBLISH");
|
|
}
|
|
continue;
|
|
}
|
|
if (fromServer && line.startsWith("PRODID:") && eventClass != null) {
|
|
result.writeLine(line);
|
|
// set global calendarserver access for iCal 4
|
|
if ("PRIVATE".equalsIgnoreCase(eventClass)) {
|
|
result.writeLine("X-CALENDARSERVER-ACCESS:CONFIDENTIAL");
|
|
} else if ("CONFIDENTIAL".equalsIgnoreCase(eventClass)) {
|
|
result.writeLine("X-CALENDARSERVER-ACCESS:PRIVATE");
|
|
} else if (eventClass != null) {
|
|
result.writeLine("X-CALENDARSERVER-ACCESS:" + eventClass);
|
|
}
|
|
continue;
|
|
}
|
|
if (!fromServer && "BEGIN:VEVENT".equals(line) && !hasTimezone) {
|
|
result.write(ExchangeSession.this.getVTimezone().timezoneBody);
|
|
hasTimezone = true;
|
|
}
|
|
if (!fromServer && currentAllDayState.isAllDay && "X-MICROSOFT-CDO-ALLDAYEVENT:FALSE".equals(line)) {
|
|
line = "X-MICROSOFT-CDO-ALLDAYEVENT:TRUE";
|
|
} else if (!fromServer && "END:VEVENT".equals(line)) {
|
|
if (!hasCdoBusyStatus) {
|
|
result.writeLine("X-MICROSOFT-CDO-BUSYSTATUS:" + (!"TRANSPARENT".equals(transp) ? "BUSY" : "FREE"));
|
|
}
|
|
if (currentAllDayState.isAllDay && !currentAllDayState.hasCdoAllDay) {
|
|
result.writeLine("X-MICROSOFT-CDO-ALLDAYEVENT:TRUE");
|
|
}
|
|
// add organizer line to all events created in Exchange for active sync
|
|
if (organizer == null) {
|
|
result.writeLine("ORGANIZER:MAILTO:" + email);
|
|
}
|
|
if (isAppleiCal) {
|
|
if ("CONFIDENTIAL".equalsIgnoreCase(eventClass)) {
|
|
result.writeLine("CLASS:PRIVATE");
|
|
} else if ("PRIVATE".equalsIgnoreCase(eventClass)) {
|
|
result.writeLine("CLASS:CONFIDENTIAL");
|
|
} else {
|
|
result.writeLine("CLASS:" + eventClass);
|
|
}
|
|
}
|
|
} else if (!fromServer && line.startsWith("X-MICROSOFT-CDO-BUSYSTATUS:")) {
|
|
line = "X-MICROSOFT-CDO-BUSYSTATUS:" + (!"TRANSPARENT".equals(transp) ? "BUSY" : "FREE");
|
|
} else if (!fromServer && !currentAllDayState.isAllDay && "X-MICROSOFT-CDO-ALLDAYEVENT:TRUE".equals(line)) {
|
|
line = "X-MICROSOFT-CDO-ALLDAYEVENT:FALSE";
|
|
} else if (fromServer && currentAllDayState.isCdoAllDay && line.startsWith("DTSTART") && !line.startsWith("DTSTART;VALUE=DATE")) {
|
|
line = getAllDayLine(line);
|
|
} else if (fromServer && currentAllDayState.isCdoAllDay && line.startsWith("DTEND") && !line.startsWith("DTEND;VALUE=DATE")) {
|
|
line = getAllDayLine(line);
|
|
} else if (!fromServer && currentAllDayState.isAllDay && line.startsWith("DTSTART") && line.startsWith("DTSTART;VALUE=DATE")) {
|
|
line = "DTSTART;TZID=\"" + ExchangeSession.this.getVTimezone().timezoneId + "\":" + line.substring(19) + "T000000";
|
|
} else if (!fromServer && currentAllDayState.isAllDay && line.startsWith("DTEND") && line.startsWith("DTEND;VALUE=DATE")) {
|
|
line = "DTEND;TZID=\"" + ExchangeSession.this.getVTimezone().timezoneId + "\":" + line.substring(17) + "T000000";
|
|
} else if (line.startsWith("TZID:") && validTimezoneId != null) {
|
|
line = "TZID:" + validTimezoneId;
|
|
} else if ("BEGIN:VEVENT".equals(line)) {
|
|
currentAllDayState = allDayStates.get(count++);
|
|
// remove calendarserver access
|
|
} else if (line.startsWith("X-CALENDARSERVER-ACCESS:")) {
|
|
continue;
|
|
} else if (line.startsWith("EXDATE;TZID=") || line.startsWith("EXDATE:")) {
|
|
// Apple iCal doesn't support EXDATE with multiple exceptions
|
|
// on one line. Split into multiple EXDATE entries (which is
|
|
// also legal according to the caldav standard).
|
|
splitExDate(result, line);
|
|
continue;
|
|
} else if (line.startsWith("X-ENTOURAGE_UUID:")) {
|
|
// Apple iCal doesn't understand this key, and it's entourage
|
|
// specific (i.e. not needed by any caldav client): strip it out
|
|
continue;
|
|
} else if (fromServer && line.startsWith("ATTENDEE;")
|
|
&& (line.indexOf(email) >= 0)) {
|
|
// If this is coming from the server, strip out RSVP for this
|
|
// user as an attendee where the partstat is something other
|
|
// than PARTSTAT=NEEDS-ACTION since the RSVP confuses iCal4 into
|
|
// thinking the attendee has not replied
|
|
|
|
int rsvpSuffix = line.indexOf("RSVP=TRUE;");
|
|
int rsvpPrefix = line.indexOf(";RSVP=TRUE");
|
|
|
|
if (((rsvpSuffix >= 0) || (rsvpPrefix >= 0))
|
|
&& (line.indexOf("PARTSTAT=") >= 0)
|
|
&& (line.indexOf("PARTSTAT=NEEDS-ACTION") < 0)) {
|
|
|
|
// Strip out the "RSVP" line from the calendar entry
|
|
if (rsvpSuffix >= 0) {
|
|
line = line.substring(0, rsvpSuffix) + line.substring(rsvpSuffix + 10);
|
|
} else {
|
|
line = line.substring(0, rsvpPrefix) + line.substring(rsvpPrefix + 10);
|
|
}
|
|
|
|
}
|
|
} else if (line.startsWith("ACTION:")) {
|
|
if (fromServer && "DISPLAY".equals(action)
|
|
// convert DISPLAY to AUDIO only if user defined an alarm sound
|
|
&& Settings.getProperty("davmail.caldavAlarmSound") != null) {
|
|
// Convert alarm to audio for iCal
|
|
result.writeLine("ACTION:AUDIO");
|
|
|
|
if (!sound) {
|
|
// Add defined sound into the audio alarm
|
|
result.writeLine("ATTACH;VALUE=URI:" + Settings.getProperty("davmail.caldavAlarmSound"));
|
|
}
|
|
|
|
continue;
|
|
} else if (!fromServer && "AUDIO".equals(action)) {
|
|
// Use the alarm action that exchange (and blackberry) understand
|
|
// (exchange and blackberry don't understand audio actions)
|
|
|
|
result.writeLine("ACTION:DISPLAY");
|
|
continue;
|
|
}
|
|
|
|
// Don't recognize this type of action: pass it through
|
|
|
|
} else if (line.startsWith("CLASS:")) {
|
|
if (!fromServer && isAppleiCal) {
|
|
continue;
|
|
} else {
|
|
// still set calendarserver access inside event for iCal 3
|
|
if ("PRIVATE".equalsIgnoreCase(eventClass)) {
|
|
result.writeLine("X-CALENDARSERVER-ACCESS:CONFIDENTIAL");
|
|
} else if ("CONFIDENTIAL".equalsIgnoreCase(eventClass)) {
|
|
result.writeLine("X-CALENDARSERVER-ACCESS:PRIVATE");
|
|
} else {
|
|
result.writeLine("X-CALENDARSERVER-ACCESS:" + eventClass);
|
|
}
|
|
}
|
|
// remove organizer line if user is organizer for iPhone
|
|
} else if (fromServer && line.startsWith("ORGANIZER") && !hasAttendee) {
|
|
continue;
|
|
} else if (organizer != null && line.startsWith("ATTENDEE") && line.contains(organizer)) {
|
|
// Ignore organizer as attendee
|
|
continue;
|
|
} else if (!fromServer && line.startsWith("ATTENDEE")) {
|
|
line = replaceIcal4Principal(line);
|
|
}
|
|
|
|
result.writeLine(line);
|
|
}
|
|
} finally {
|
|
reader.close();
|
|
}
|
|
|
|
String resultString = result.toString();
|
|
dumpICS(resultString, fromServer, true);
|
|
|
|
return resultString;
|
|
}
|
|
|
|
protected void dumpICS(String icsBody, boolean fromServer, boolean after) {
|
|
String logFileDirectory = Settings.getLogFileDirectory();
|
|
|
|
// additional setting to activate ICS dump (not available in GUI)
|
|
int dumpMax = Settings.getIntProperty("davmail.dumpICS");
|
|
if (dumpMax > 0) {
|
|
if (dumpIndex > dumpMax) {
|
|
// Delete the oldest dump file
|
|
final int oldest = dumpIndex - dumpMax;
|
|
try {
|
|
File[] oldestFiles = (new File(logFileDirectory)).listFiles(new FilenameFilter() {
|
|
public boolean accept(File dir, String name) {
|
|
if (name.endsWith(".ics")) {
|
|
int dashIndex = name.indexOf('-');
|
|
if (dashIndex > 0) {
|
|
try {
|
|
int fileIndex = Integer.parseInt(name.substring(0, dashIndex));
|
|
return fileIndex < oldest;
|
|
} catch (NumberFormatException nfe) {
|
|
// ignore
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
});
|
|
for (File file : oldestFiles) {
|
|
if (!file.delete()) {
|
|
LOGGER.warn("Unable to delete " + file.getAbsolutePath());
|
|
}
|
|
}
|
|
} catch (Exception ex) {
|
|
LOGGER.warn("Error deleting ics dump: " + ex.getMessage());
|
|
}
|
|
}
|
|
|
|
StringBuilder filePath = new StringBuilder();
|
|
filePath.append(logFileDirectory).append('/')
|
|
.append(dumpIndex)
|
|
.append(after ? "-to" : "-from")
|
|
.append((after ^ fromServer) ? "-server" : "-client")
|
|
.append(".ics");
|
|
if ((icsBody != null) && (icsBody.length() > 0)) {
|
|
FileWriter fileWriter = null;
|
|
try {
|
|
fileWriter = new FileWriter(filePath.toString());
|
|
fileWriter.write(icsBody);
|
|
} catch (IOException e) {
|
|
LOGGER.error(e);
|
|
} finally {
|
|
if (fileWriter != null) {
|
|
try {
|
|
fileWriter.close();
|
|
} catch (IOException e) {
|
|
LOGGER.error(e);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
protected String getICSValue(String icsBody, String prefix, String defval) throws IOException {
|
|
// only return values in VEVENT section, not VALARM
|
|
Stack<String> sectionStack = new Stack<String>();
|
|
BufferedReader reader = null;
|
|
|
|
try {
|
|
reader = new ICSBufferedReader(new StringReader(icsBody));
|
|
String line;
|
|
while ((line = reader.readLine()) != null) {
|
|
if (line.startsWith("BEGIN:")) {
|
|
sectionStack.push(line);
|
|
} else if (line.startsWith("END:") && !sectionStack.isEmpty()) {
|
|
sectionStack.pop();
|
|
} else if (!sectionStack.isEmpty() && "BEGIN:VEVENT".equals(sectionStack.peek()) && line.startsWith(prefix)) {
|
|
return line.substring(prefix.length());
|
|
}
|
|
}
|
|
|
|
} finally {
|
|
if (reader != null) {
|
|
reader.close();
|
|
}
|
|
}
|
|
|
|
return defval;
|
|
}
|
|
|
|
protected String getICSSummary(String icsBody) throws IOException {
|
|
return getICSValue(icsBody, "SUMMARY:", BundleMessage.format("MEETING_REQUEST"));
|
|
}
|
|
|
|
protected String getICSDescription(String icsBody) throws IOException {
|
|
return getICSValue(icsBody, "DESCRIPTION:", "");
|
|
}
|
|
|
|
class Participants {
|
|
String attendees;
|
|
String optionalAttendees;
|
|
String organizer;
|
|
}
|
|
|
|
/**
|
|
* Parse ics event for attendees and organizer.
|
|
* For notifications, only include attendees with RSVP=TRUE or PARTSTAT=NEEDS-ACTION
|
|
*
|
|
* @param isNotification get only notified attendees
|
|
* @return participants
|
|
* @throws IOException on error
|
|
*/
|
|
protected Participants getParticipants(boolean isNotification) throws IOException {
|
|
HashSet<String> attendees = new HashSet<String>();
|
|
HashSet<String> optionalAttendees = new HashSet<String>();
|
|
String organizer = null;
|
|
BufferedReader reader = null;
|
|
try {
|
|
reader = new ICSBufferedReader(new StringReader(itemBody));
|
|
String line;
|
|
while ((line = reader.readLine()) != null) {
|
|
int index = line.indexOf(':');
|
|
if (index >= 0) {
|
|
String key = line.substring(0, index);
|
|
String value = line.substring(index + 1);
|
|
int semiColon = key.indexOf(';');
|
|
if (semiColon >= 0) {
|
|
key = key.substring(0, semiColon);
|
|
}
|
|
if ("ORGANIZER".equals(key) || "ATTENDEE".equals(key)) {
|
|
int colonIndex = value.indexOf(':');
|
|
if (colonIndex >= 0) {
|
|
value = value.substring(colonIndex + 1);
|
|
}
|
|
value = replaceIcal4Principal(value);
|
|
if ("ORGANIZER".equals(key)) {
|
|
organizer = value;
|
|
// exclude current user and invalid values from recipients
|
|
// also exclude no action attendees
|
|
} else if (!email.equalsIgnoreCase(value) && value.indexOf('@') >= 0
|
|
// return all attendees for user calendar folder, filter for notifications
|
|
&& (!isNotification
|
|
// notify attendee if reply explicitly requested
|
|
|| (line.indexOf("RSVP=TRUE") >= 0)
|
|
|| (
|
|
// workaround for iCal bug: do not notify if reply explicitly not requested
|
|
!(line.indexOf("RSVP=FALSE") >= 0) &&
|
|
((line.indexOf("PARTSTAT=NEEDS-ACTION") >= 0
|
|
// need to include other PARTSTATs participants for CANCEL notifications
|
|
|| line.indexOf("PARTSTAT=ACCEPTED") >= 0
|
|
|| line.indexOf("PARTSTAT=DECLINED") >= 0
|
|
|| line.indexOf("PARTSTAT=TENTATIVE") >= 0))
|
|
))) {
|
|
if (line.indexOf("ROLE=OPT-PARTICIPANT") >= 0) {
|
|
optionalAttendees.add(value);
|
|
} else {
|
|
attendees.add(value);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} finally {
|
|
if (reader != null) {
|
|
reader.close();
|
|
}
|
|
}
|
|
Participants participants = new Participants();
|
|
participants.attendees = StringUtil.join(attendees, ", ");
|
|
participants.optionalAttendees = StringUtil.join(optionalAttendees, ", ");
|
|
participants.organizer = organizer;
|
|
return participants;
|
|
}
|
|
|
|
protected String getICSMethod(String icsBody) {
|
|
String icsMethod = StringUtil.getToken(icsBody, "METHOD:", "\r");
|
|
if (icsMethod == null) {
|
|
// default method is REQUEST
|
|
icsMethod = "REQUEST";
|
|
}
|
|
return icsMethod;
|
|
}
|
|
|
|
/**
|
|
* Create or update item
|
|
*
|
|
* @return action result
|
|
* @throws IOException on error
|
|
*/
|
|
public ItemResult createOrUpdate() throws IOException {
|
|
String boundary = UUID.randomUUID().toString();
|
|
ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
|
MimeOutputStreamWriter writer = new MimeOutputStreamWriter(baos);
|
|
int status = 0;
|
|
String method = getICSMethod(itemBody);
|
|
|
|
writer.writeHeader("Content-Transfer-Encoding", "7bit");
|
|
writer.writeHeader("Content-class", contentClass);
|
|
// append date
|
|
writer.writeHeader("Date", new Date());
|
|
|
|
// Make sure invites have a proper subject line
|
|
writer.writeHeader("Subject", getICSSummary(itemBody));
|
|
|
|
if ("urn:content-classes:calendarmessage".equals(contentClass)) {
|
|
// need to parse attendees and organizer to build recipients
|
|
Participants participants = getParticipants(true);
|
|
if (email.equalsIgnoreCase(participants.organizer)) {
|
|
// current user is organizer => notify all
|
|
writer.writeHeader("To", participants.attendees);
|
|
writer.writeHeader("Cc", participants.optionalAttendees);
|
|
// do not send notification if no recipients found
|
|
if (participants.attendees == null && participants.optionalAttendees == null) {
|
|
status = HttpStatus.SC_NO_CONTENT;
|
|
}
|
|
} else {
|
|
// notify only organizer
|
|
writer.writeHeader("To", participants.organizer);
|
|
// do not send notification if no recipients found
|
|
if (participants.organizer == null) {
|
|
status = HttpStatus.SC_NO_CONTENT;
|
|
}
|
|
}
|
|
|
|
} else {
|
|
// need to parse attendees and organizer to build recipients
|
|
Participants participants = getParticipants(false);
|
|
// storing appointment, full recipients header
|
|
if (participants.attendees != null) {
|
|
writer.writeHeader("To", participants.attendees);
|
|
} else {
|
|
// use current user as attendee
|
|
writer.writeHeader("To", email);
|
|
}
|
|
writer.writeHeader("Cc", participants.optionalAttendees);
|
|
|
|
if (participants.organizer != null) {
|
|
writer.writeHeader("From", participants.organizer);
|
|
} else {
|
|
writer.writeHeader("From", email);
|
|
}
|
|
// if not organizer, set REPLYTIME to force Outlook in attendee mode
|
|
if (participants.organizer != null && !email.equalsIgnoreCase(participants.organizer)) {
|
|
if (itemBody.indexOf("METHOD:") < 0) {
|
|
itemBody = itemBody.replaceAll("BEGIN:VCALENDAR", "BEGIN:VCALENDAR\r\nMETHOD:REQUEST");
|
|
}
|
|
if (itemBody.indexOf("X-MICROSOFT-CDO-REPLYTIME") < 0) {
|
|
itemBody = itemBody.replaceAll("END:VEVENT", "X-MICROSOFT-CDO-REPLYTIME:" +
|
|
getZuluDateFormat().format(new Date()) + "\r\nEND:VEVENT");
|
|
}
|
|
}
|
|
}
|
|
writer.writeHeader("MIME-Version", "1.0");
|
|
writer.writeHeader("Content-Type", "multipart/alternative;\r\n" +
|
|
"\tboundary=\"----=_NextPart_" + boundary + '\"');
|
|
writer.writeLn();
|
|
writer.writeLn("This is a multi-part message in MIME format.");
|
|
writer.writeLn();
|
|
writer.writeLn("------=_NextPart_" + boundary);
|
|
|
|
// Write a part of the message that contains the
|
|
// ICS description so that invites contain the description text
|
|
String description = getICSDescription(itemBody).replaceAll("\\\\[Nn]", "\r\n");
|
|
|
|
if (description.length() > 0) {
|
|
writer.writeHeader("Content-Type", "text/plain;\r\n" +
|
|
"\tcharset=\"utf-8\"");
|
|
writer.writeHeader("content-transfer-encoding", "8bit");
|
|
writer.writeLn();
|
|
writer.flush();
|
|
baos.write(description.getBytes("UTF-8"));
|
|
writer.writeLn();
|
|
writer.writeLn("------=_NextPart_" + boundary);
|
|
}
|
|
writer.writeHeader("Content-class", contentClass);
|
|
writer.writeHeader("Content-Type", "text/calendar;\r\n" +
|
|
"\tmethod=" + method + ";\r\n" +
|
|
"\tcharset=\"utf-8\""
|
|
);
|
|
writer.writeHeader("Content-Transfer-Encoding", "8bit");
|
|
writer.writeLn();
|
|
writer.flush();
|
|
baos.write(fixICS(itemBody, false).getBytes("UTF-8"));
|
|
writer.writeLn();
|
|
writer.writeLn("------=_NextPart_" + boundary + "--");
|
|
writer.close();
|
|
|
|
ItemResult itemResult;
|
|
if (status == 0) {
|
|
itemResult = createOrUpdate(baos.toByteArray());
|
|
} else {
|
|
itemResult = new ItemResult();
|
|
itemResult.status = status;
|
|
}
|
|
|
|
return itemResult;
|
|
|
|
}
|
|
|
|
protected abstract ItemResult createOrUpdate(byte[] mimeContent) throws IOException;
|
|
|
|
}
|
|
|
|
/**
|
|
* Common item properties
|
|
*/
|
|
protected static final Set<String> ITEM_PROPERTIES = new HashSet<String>();
|
|
|
|
static {
|
|
ITEM_PROPERTIES.add("etag");
|
|
ITEM_PROPERTIES.add("displayname");
|
|
// calendar CdoInstanceType
|
|
ITEM_PROPERTIES.add("instancetype");
|
|
ITEM_PROPERTIES.add("urlcompname");
|
|
}
|
|
|
|
/**
|
|
* Search contacts in provided folder.
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @return list of contacts
|
|
* @throws IOException on error
|
|
*/
|
|
public List<ExchangeSession.Contact> getAllContacts(String folderPath) throws IOException {
|
|
return searchContacts(folderPath, ITEM_PROPERTIES, equals("outlookmessageclass", "IPM.Contact"));
|
|
}
|
|
|
|
|
|
/**
|
|
* Search contacts in provided folder matching the search query.
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @param attributes requested attributes
|
|
* @param condition Exchange search query
|
|
* @return list of contacts
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract List<Contact> searchContacts(String folderPath, Set<String> attributes, Condition condition) throws IOException;
|
|
|
|
/**
|
|
* Search calendar messages in provided folder.
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @return list of calendar messages as Event objects
|
|
* @throws IOException on error
|
|
*/
|
|
public List<Event> getEventMessages(String folderPath) throws IOException {
|
|
return searchEvents(folderPath, ITEM_PROPERTIES,
|
|
and(equals("outlookmessageclass", "IPM.Schedule.Meeting.Request"),
|
|
or(isNull("processed"), isFalse("processed"))));
|
|
}
|
|
|
|
/**
|
|
* Search calendar events in provided folder.
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @return list of calendar events
|
|
* @throws IOException on error
|
|
*/
|
|
public List<Event> getAllEvents(String folderPath) throws IOException {
|
|
int caldavPastDelay = Settings.getIntProperty("davmail.caldavPastDelay");
|
|
Condition dateCondition = null;
|
|
if (caldavPastDelay != 0) {
|
|
Calendar cal = Calendar.getInstance();
|
|
cal.add(Calendar.DAY_OF_MONTH, -caldavPastDelay);
|
|
dateCondition = gt("dtstart", formatSearchDate(cal.getTime()));
|
|
}
|
|
|
|
Condition privateCondition = null;
|
|
if (isSharedFolder(folderPath)) {
|
|
LOGGER.debug("Shared or public calendar: exclude private events");
|
|
privateCondition = equals("sensitivity", 0);
|
|
}
|
|
|
|
|
|
return searchEvents(folderPath, ITEM_PROPERTIES,
|
|
and(or(isNull("instancetype"),
|
|
equals("instancetype", 1),
|
|
and(equals("instancetype", 0), dateCondition)),
|
|
equals("outlookmessageclass", "IPM.Appointment"),
|
|
privateCondition));
|
|
}
|
|
|
|
|
|
/**
|
|
* Search calendar events or messages in provided folder matching the search query.
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @param attributes requested attributes
|
|
* @param condition Exchange search query
|
|
* @return list of calendar messages as Event objects
|
|
* @throws IOException on error
|
|
*/
|
|
protected abstract List<Event> searchEvents(String folderPath, Set<String> attributes, Condition condition) throws IOException;
|
|
|
|
/**
|
|
* convert vcf extension to EML.
|
|
*
|
|
* @param itemName item name
|
|
* @return EML item name
|
|
*/
|
|
protected String convertItemNameToEML(String itemName) {
|
|
if (itemName.endsWith(".vcf")) {
|
|
return itemName.substring(0, itemName.length() - 3) + "EML";
|
|
} else {
|
|
return itemName;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get item named eventName in folder
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @param itemName event name
|
|
* @return event object
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract Item getItem(String folderPath, String itemName) throws IOException;
|
|
|
|
/**
|
|
* Contact picture
|
|
*/
|
|
public static class ContactPhoto {
|
|
/**
|
|
* Contact picture content type (always image/jpeg on read)
|
|
*/
|
|
public String contentType;
|
|
/**
|
|
* Base64 encoded picture content
|
|
*/
|
|
public String content;
|
|
}
|
|
|
|
/**
|
|
* Retrieve contact photo attached to contact
|
|
*
|
|
* @param contact address book contact
|
|
* @return contact photo
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract ContactPhoto getContactPhoto(Contact contact) throws IOException;
|
|
|
|
|
|
/**
|
|
* Delete event named itemName in folder
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @param itemName item name
|
|
* @return HTTP status
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract int deleteItem(String folderPath, String itemName) throws IOException;
|
|
|
|
/**
|
|
* Mark event processed named eventName in folder
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @param itemName item name
|
|
* @return HTTP status
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract int processItem(String folderPath, String itemName) throws IOException;
|
|
|
|
|
|
private static int dumpIndex;
|
|
|
|
/**
|
|
* Replace iCal4 (Snow Leopard) principal paths with mailto expression
|
|
*
|
|
* @param value attendee value or ics line
|
|
* @return fixed value
|
|
*/
|
|
protected String replaceIcal4Principal(String value) {
|
|
if (value.contains("/principals/__uuids__/")) {
|
|
return value.replaceAll("/principals/__uuids__/([^/]*)__AT__([^/]*)/", "mailto:$1@$2");
|
|
} else {
|
|
return value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Event result object to hold HTTP status and event etag from an event creation/update.
|
|
*/
|
|
public static class ItemResult {
|
|
/**
|
|
* HTTP status
|
|
*/
|
|
public int status;
|
|
/**
|
|
* Event etag from response HTTP header
|
|
*/
|
|
public String etag;
|
|
}
|
|
|
|
/**
|
|
* Build and send the MIME message for the provided ICS event.
|
|
*
|
|
* @param icsBody event in iCalendar format
|
|
* @return HTTP status
|
|
* @throws IOException on error
|
|
*/
|
|
public abstract int sendEvent(String icsBody) throws IOException;
|
|
|
|
/**
|
|
* Create or update item (event or contact) on the Exchange server
|
|
*
|
|
* @param folderPath Exchange folder path
|
|
* @param itemName event name
|
|
* @param itemBody event body in iCalendar format
|
|
* @param etag previous event etag to detect concurrent updates
|
|
* @param noneMatch if-none-match header value
|
|
* @return HTTP response event result (status and etag)
|
|
* @throws IOException on error
|
|
*/
|
|
public ItemResult createOrUpdateItem(String folderPath, String itemName, String itemBody, String etag, String noneMatch) throws IOException {
|
|
if (itemBody.startsWith("BEGIN:VCALENDAR")) {
|
|
return internalCreateOrUpdateEvent(folderPath, itemName, "urn:content-classes:appointment", itemBody, etag, noneMatch);
|
|
} else if (itemBody.startsWith("BEGIN:VCARD")) {
|
|
return createOrUpdateContact(folderPath, itemName, itemBody, etag, noneMatch);
|
|
} else {
|
|
throw new IOException(BundleMessage.format("EXCEPTION_INVALID_MESSAGE_CONTENT", itemBody));
|
|
}
|
|
}
|
|
|
|
protected static final String[] VCARD_N_PROPERTIES = {"sn", "givenName", "middlename", "personaltitle", "namesuffix"};
|
|
protected static final String[] VCARD_ADR_HOME_PROPERTIES = {"homepostofficebox", null, "homeStreet", "homeCity", "homeState", "homePostalCode", "homeCountry"};
|
|
protected static final String[] VCARD_ADR_WORK_PROPERTIES = {"postofficebox", "roomnumber", "street", "l", "st", "postalcode", "co"};
|
|
protected static final String[] VCARD_ADR_OTHER_PROPERTIES = {"otherpostofficebox", null, "otherstreet", "othercity", "otherstate", "otherpostalcode", "othercountry"};
|
|
protected static final String[] VCARD_ORG_PROPERTIES = {"o", "department"};
|
|
|
|
protected void convertContactProperties(Map<String, String> properties, String[] contactProperties, List<String> values) {
|
|
for (int i = 0; i < values.size() && i < contactProperties.length; i++) {
|
|
if (contactProperties[i] != null) {
|
|
properties.put(contactProperties[i], values.get(i));
|
|
}
|
|
}
|
|
}
|
|
|
|
protected ItemResult createOrUpdateContact(String folderPath, String itemName, String itemBody, String etag, String noneMatch) throws IOException {
|
|
// parse VCARD body to build contact property map
|
|
Map<String, String> properties = new HashMap<String, String>();
|
|
properties.put("outlookmessageclass", "IPM.Contact");
|
|
|
|
VCardReader reader = new VCardReader(new StringReader(itemBody));
|
|
VCardReader.Property property;
|
|
while ((property = reader.readProperty()) != null) {
|
|
if ("FN".equals(property.getKey())) {
|
|
properties.put("cn", property.getValue());
|
|
properties.put("subject", property.getValue());
|
|
properties.put("fileas", property.getValue());
|
|
|
|
} else if ("N".equals(property.getKey())) {
|
|
convertContactProperties(properties, VCARD_N_PROPERTIES, property.getValues());
|
|
} else if ("NICKNAME".equals(property.getKey())) {
|
|
properties.put("nickname", property.getValue());
|
|
} else if ("TEL".equals(property.getKey())) {
|
|
if (property.hasParam("TYPE", "cell") || property.hasParam("X-GROUP", "CELL")) {
|
|
properties.put("mobile", property.getValue());
|
|
}
|
|
if (property.hasParam("TYPE", "work") || property.hasParam("X-GROUP", "WORK")) {
|
|
properties.put("telephoneNumber", property.getValue());
|
|
}
|
|
if (property.hasParam("TYPE", "home") || property.hasParam("X-GROUP", "HOME")) {
|
|
properties.put("homePhone", property.getValue());
|
|
}
|
|
if (property.hasParam("TYPE", "fax")) {
|
|
properties.put("facsimiletelephonenumber", property.getValue());
|
|
}
|
|
if (property.hasParam("TYPE", "pager")) {
|
|
properties.put("pager", property.getValue());
|
|
}
|
|
} else if ("ADR".equals(property.getKey())) {
|
|
// address
|
|
if (property.hasParam("TYPE", "home")) {
|
|
convertContactProperties(properties, VCARD_ADR_HOME_PROPERTIES, property.getValues());
|
|
} else if (property.hasParam("TYPE", "work")) {
|
|
convertContactProperties(properties, VCARD_ADR_WORK_PROPERTIES, property.getValues());
|
|
} else if (property.hasParam("TYPE", "other")) {
|
|
convertContactProperties(properties, VCARD_ADR_OTHER_PROPERTIES, property.getValues());
|
|
}
|
|
} else if ("EMAIL".equals(property.getKey())) {
|
|
if (property.hasParam("TYPE", "work")) {
|
|
properties.put("email1", property.getValue());
|
|
}
|
|
if (property.hasParam("TYPE", "home")) {
|
|
properties.put("email2", property.getValue());
|
|
}
|
|
if (property.hasParam("TYPE", "other")) {
|
|
properties.put("email3", property.getValue());
|
|
}
|
|
} else if ("ORG".equals(property.getKey())) {
|
|
convertContactProperties(properties, VCARD_ORG_PROPERTIES, property.getValues());
|
|
} else if ("URL".equals(property.getKey())) {
|
|
if (property.hasParam("TYPE", "work")) {
|
|
properties.put("businesshomepage", property.getValue());
|
|
}
|
|
} else if ("TITLE".equals(property.getKey())) {
|
|
properties.put("title", property.getValue());
|
|
} else if ("NOTE".equals(property.getKey())) {
|
|
properties.put("description", property.getValue());
|
|
} else if ("CUSTOM1".equals(property.getKey())) {
|
|
properties.put("extensionattribute1", property.getValue());
|
|
} else if ("CUSTOM2".equals(property.getKey())) {
|
|
properties.put("extensionattribute2", property.getValue());
|
|
} else if ("CUSTOM3".equals(property.getKey())) {
|
|
properties.put("extensionattribute3", property.getValue());
|
|
} else if ("CUSTOM4".equals(property.getKey())) {
|
|
properties.put("extensionattribute4", property.getValue());
|
|
} else if ("ROLE".equals(property.getKey())) {
|
|
properties.put("profession", property.getValue());
|
|
} else if ("X-AIM".equals(property.getKey())) {
|
|
properties.put("im", property.getValue());
|
|
} else if ("BDAY".equals(property.getKey())) {
|
|
String value = property.getValue();
|
|
if (value != null) {
|
|
try {
|
|
properties.put("bday", ExchangeSession.getExchangeZuluDateFormatMillisecond().format(ExchangeSession.getZuluDateFormat().parse(value)));
|
|
} catch (ParseException e) {
|
|
LOGGER.warn("Invalid date: " + value);
|
|
}
|
|
}
|
|
} else if ("CATEGORIES".equals(property.getKey())) {
|
|
properties.put("keywords", property.getValue());
|
|
} else if ("CLASS".equals(property.getKey())) {
|
|
if ("PUBLIC".equals(property.getValue())) {
|
|
properties.put("sensitivity", "0");
|
|
properties.put("private", "false");
|
|
} else {
|
|
properties.put("sensitivity", "2");
|
|
properties.put("private", "true");
|
|
}
|
|
} else if ("X-ASSISTANT".equals(property.getKey())) {
|
|
properties.put("secretarycn", property.getValue());
|
|
} else if ("X-MANAGER".equals(property.getKey())) {
|
|
properties.put("manager", property.getValue());
|
|
} else if ("X-SPOUSE".equals(property.getKey())) {
|
|
properties.put("spousecn", property.getValue());
|
|
} else if ("PHOTO".equals(property.getKey())) {
|
|
properties.put("photo", property.getValue());
|
|
properties.put("haspicture", "true");
|
|
}
|
|
}
|
|
// reset missing properties to null
|
|
for (String key : CONTACT_ATTRIBUTES) {
|
|
if (!"imapUid".equals(key) && !"etag".equals(key) && !"urlcompname".equals(key)
|
|
&& !"lastmodified".equals(key) &&
|
|
!properties.containsKey(key)) {
|
|
properties.put(key, null);
|
|
}
|
|
}
|
|
|
|
return internalCreateOrUpdateContact(folderPath, itemName, properties, etag, noneMatch);
|
|
}
|
|
|
|
|
|
protected abstract ItemResult internalCreateOrUpdateContact(String folderPath, String itemName, Map<String, String> properties, String etag, String noneMatch) throws IOException;
|
|
|
|
protected abstract ItemResult internalCreateOrUpdateEvent(String folderPath, String itemName, String contentClass, String icsBody, String etag, String noneMatch) throws IOException;
|
|
|
|
/**
|
|
* Get current Exchange alias name from login name
|
|
*
|
|
* @return user name
|
|
*/
|
|
protected String getAliasFromLogin() {
|
|
// Exchange 2007 : userName is login without domain
|
|
String result = this.userName;
|
|
int index = result.indexOf('\\');
|
|
if (index >= 0) {
|
|
result = result.substring(index + 1);
|
|
}
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Get current Exchange alias name from mailbox name
|
|
*
|
|
* @return user name
|
|
*/
|
|
protected String getAliasFromMailPath() {
|
|
if (mailPath == null) {
|
|
return null;
|
|
}
|
|
int index = mailPath.lastIndexOf('/', mailPath.length() - 2);
|
|
if (index >= 0 && mailPath.endsWith("/")) {
|
|
return mailPath.substring(index + 1, mailPath.length() - 1);
|
|
} else {
|
|
LOGGER.warn(new BundleMessage("EXCEPTION_INVALID_MAIL_PATH", mailPath));
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get user alias from mailbox display name over Webdav.
|
|
*
|
|
* @return user alias
|
|
*/
|
|
public String getAliasFromMailboxDisplayName() {
|
|
if (mailPath == null) {
|
|
return null;
|
|
}
|
|
String displayName = null;
|
|
try {
|
|
Folder rootFolder = getFolder("");
|
|
if (rootFolder == null) {
|
|
LOGGER.warn(new BundleMessage("EXCEPTION_UNABLE_TO_GET_MAIL_FOLDER", mailPath));
|
|
} else {
|
|
displayName = rootFolder.displayName;
|
|
}
|
|
} catch (IOException e) {
|
|
LOGGER.warn(new BundleMessage("EXCEPTION_UNABLE_TO_GET_MAIL_FOLDER", mailPath));
|
|
}
|
|
return displayName;
|
|
}
|
|
|
|
/**
|
|
* Test if folderPath is inside user mailbox.
|
|
*
|
|
* @param folderPath absolute folder path
|
|
* @return true if folderPath is a public or shared folder
|
|
*/
|
|
public abstract boolean isSharedFolder(String folderPath);
|
|
|
|
/**
|
|
* Build base path for cmd commands (galfind, gallookup).
|
|
* This does not work with freebusy, which requires /public/
|
|
*
|
|
* @return cmd base path
|
|
*/
|
|
public String getCmdBasePath() {
|
|
if (mailPath == null) {
|
|
if (publicFolderUrl == null) {
|
|
return "/public/";
|
|
} else {
|
|
return publicFolderUrl + '/';
|
|
}
|
|
} else {
|
|
return mailPath;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get user email from global address list (galfind).
|
|
*
|
|
* @param alias user alias
|
|
* @return user email
|
|
*/
|
|
public String getEmail(String alias) {
|
|
String emailResult = null;
|
|
if (alias != null) {
|
|
GetMethod getMethod = null;
|
|
String path = null;
|
|
try {
|
|
path = getCmdBasePath() + "?Cmd=galfind&AN=" + URIUtil.encodeWithinQuery(alias);
|
|
getMethod = new GetMethod(path);
|
|
DavGatewayHttpClientFacade.executeGetMethod(httpClient, getMethod, true);
|
|
Map<String, Map<String, String>> results = XMLStreamUtil.getElementContentsAsMap(getMethod.getResponseBodyAsStream(), "item", "AN");
|
|
Map<String, String> result = results.get(alias.toLowerCase());
|
|
if (result != null) {
|
|
emailResult = result.get("EM");
|
|
}
|
|
} catch (IOException e) {
|
|
LOGGER.debug("GET " + path + " failed: " + e + ' ' + e.getMessage());
|
|
} finally {
|
|
if (getMethod != null) {
|
|
getMethod.releaseConnection();
|
|
}
|
|
}
|
|
}
|
|
return emailResult;
|
|
}
|
|
|
|
/**
|
|
* Determine user email through various means.
|
|
*
|
|
* @param hostName Exchange server host name for last failover
|
|
*/
|
|
public void buildEmail(String hostName) {
|
|
// first try to get email from login name
|
|
alias = getAliasFromLogin();
|
|
email = getEmail(alias);
|
|
// failover: use mailbox name as alias
|
|
if (email == null) {
|
|
alias = getAliasFromMailPath();
|
|
email = getEmail(alias);
|
|
}
|
|
// another failover : get alias from mailPath display name
|
|
if (email == null) {
|
|
alias = getAliasFromMailboxDisplayName();
|
|
email = getEmail(alias);
|
|
}
|
|
if (email == null) {
|
|
// failover : get email from Exchange 2007 Options page
|
|
alias = getAliasFromOptions();
|
|
email = getEmail(alias);
|
|
// failover: get email from options
|
|
if (alias != null && email == null) {
|
|
email = getEmailFromOptions();
|
|
}
|
|
}
|
|
if (email == null) {
|
|
LOGGER.debug("Unable to get user email with alias " + getAliasFromLogin()
|
|
+ " or " + getAliasFromMailPath()
|
|
+ " or " + getAliasFromOptions()
|
|
);
|
|
// last failover: build email from domain name and mailbox display name
|
|
StringBuilder buffer = new StringBuilder();
|
|
// most reliable alias
|
|
alias = getAliasFromMailboxDisplayName();
|
|
if (alias == null) {
|
|
alias = getAliasFromLogin();
|
|
}
|
|
if (alias != null) {
|
|
buffer.append(alias);
|
|
if (alias.indexOf('@') < 0) {
|
|
buffer.append('@');
|
|
int dotIndex = hostName.indexOf('.');
|
|
if (dotIndex >= 0) {
|
|
buffer.append(hostName.substring(dotIndex + 1));
|
|
}
|
|
}
|
|
}
|
|
email = buffer.toString();
|
|
}
|
|
}
|
|
|
|
static final String MAILBOX_BASE = "/cn=";
|
|
|
|
protected String getAliasFromOptions() {
|
|
String result = null;
|
|
// get user mail URL from html body
|
|
BufferedReader optionsPageReader = null;
|
|
GetMethod optionsMethod = new GetMethod("/owa/?ae=Options&t=About");
|
|
try {
|
|
DavGatewayHttpClientFacade.executeGetMethod(httpClient, optionsMethod, false);
|
|
optionsPageReader = new BufferedReader(new InputStreamReader(optionsMethod.getResponseBodyAsStream()));
|
|
String line;
|
|
// find mailbox full name
|
|
//noinspection StatementWithEmptyBody
|
|
while ((line = optionsPageReader.readLine()) != null && line.toLowerCase().indexOf(MAILBOX_BASE) == -1) {
|
|
}
|
|
if (line != null) {
|
|
int start = line.toLowerCase().lastIndexOf(MAILBOX_BASE) + MAILBOX_BASE.length();
|
|
int end = line.indexOf('<', start);
|
|
result = line.substring(start, end);
|
|
}
|
|
} catch (IOException e) {
|
|
LOGGER.error("Error parsing options page at " + optionsMethod.getPath());
|
|
} finally {
|
|
if (optionsPageReader != null) {
|
|
try {
|
|
optionsPageReader.close();
|
|
} catch (IOException e) {
|
|
LOGGER.error("Error parsing options page at " + optionsMethod.getPath());
|
|
}
|
|
}
|
|
optionsMethod.releaseConnection();
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
protected String getEmailFromOptions() {
|
|
String result = null;
|
|
// get user mail URL from html body
|
|
BufferedReader optionsPageReader = null;
|
|
GetMethod optionsMethod = new GetMethod("/owa/?ae=Options&t=About");
|
|
try {
|
|
DavGatewayHttpClientFacade.executeGetMethod(httpClient, optionsMethod, false);
|
|
optionsPageReader = new BufferedReader(new InputStreamReader(optionsMethod.getResponseBodyAsStream()));
|
|
String line;
|
|
// find email
|
|
//noinspection StatementWithEmptyBody
|
|
while ((line = optionsPageReader.readLine()) != null
|
|
&& (line.indexOf('[') == -1
|
|
|| line.indexOf('@') == -1
|
|
|| line.indexOf(']') == -1)) {
|
|
}
|
|
if (line != null) {
|
|
int start = line.toLowerCase().indexOf('[') + 1;
|
|
int end = line.indexOf(']', start);
|
|
result = line.substring(start, end);
|
|
}
|
|
} catch (IOException e) {
|
|
LOGGER.error("Error parsing options page at " + optionsMethod.getPath());
|
|
} finally {
|
|
if (optionsPageReader != null) {
|
|
try {
|
|
optionsPageReader.close();
|
|
} catch (IOException e) {
|
|
LOGGER.error("Error parsing options page at " + optionsMethod.getPath());
|
|
}
|
|
}
|
|
optionsMethod.releaseConnection();
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Get current user email
|
|
*
|
|
* @return user email
|
|
*/
|
|
public String getEmail() {
|
|
return email;
|
|
}
|
|
|
|
/**
|
|
* Get current user alias
|
|
*
|
|
* @return user email
|
|
*/
|
|
public String getAlias() {
|
|
return alias;
|
|
}
|
|
|
|
/**
|
|
* Search users in global address book
|
|
*
|
|
* @param searchAttribute exchange search attribute
|
|
* @param searchValue search value
|
|
* @return List of users
|
|
* @throws IOException on error
|
|
*/
|
|
public Map<String, Map<String, String>> galFind(String searchAttribute, String searchValue) throws IOException {
|
|
Map<String, Map<String, String>> results;
|
|
GetMethod getMethod = new GetMethod(URIUtil.encodePathQuery(getCmdBasePath() + "?Cmd=galfind&" + searchAttribute + '=' + searchValue));
|
|
try {
|
|
DavGatewayHttpClientFacade.executeGetMethod(httpClient, getMethod, true);
|
|
results = XMLStreamUtil.getElementContentsAsMap(getMethod.getResponseBodyAsStream(), "item", "AN");
|
|
} finally {
|
|
getMethod.releaseConnection();
|
|
}
|
|
LOGGER.debug("galfind " + searchAttribute + '=' + searchValue + ": " + results.size() + " result(s)");
|
|
return results;
|
|
}
|
|
|
|
/**
|
|
* Full Contact attribute list
|
|
*/
|
|
public static final Set<String> CONTACT_ATTRIBUTES = new HashSet<String>();
|
|
|
|
static {
|
|
CONTACT_ATTRIBUTES.add("imapUid");
|
|
CONTACT_ATTRIBUTES.add("etag");
|
|
CONTACT_ATTRIBUTES.add("urlcompname");
|
|
|
|
CONTACT_ATTRIBUTES.add("extensionattribute1");
|
|
CONTACT_ATTRIBUTES.add("extensionattribute2");
|
|
CONTACT_ATTRIBUTES.add("extensionattribute3");
|
|
CONTACT_ATTRIBUTES.add("extensionattribute4");
|
|
CONTACT_ATTRIBUTES.add("bday");
|
|
CONTACT_ATTRIBUTES.add("businesshomepage");
|
|
CONTACT_ATTRIBUTES.add("cn");
|
|
CONTACT_ATTRIBUTES.add("co");
|
|
CONTACT_ATTRIBUTES.add("department");
|
|
CONTACT_ATTRIBUTES.add("email1");
|
|
CONTACT_ATTRIBUTES.add("email2");
|
|
CONTACT_ATTRIBUTES.add("email3");
|
|
CONTACT_ATTRIBUTES.add("facsimiletelephonenumber");
|
|
CONTACT_ATTRIBUTES.add("givenName");
|
|
CONTACT_ATTRIBUTES.add("homeCity");
|
|
CONTACT_ATTRIBUTES.add("homeCountry");
|
|
CONTACT_ATTRIBUTES.add("homePhone");
|
|
CONTACT_ATTRIBUTES.add("homePostalCode");
|
|
CONTACT_ATTRIBUTES.add("homeState");
|
|
CONTACT_ATTRIBUTES.add("homeStreet");
|
|
CONTACT_ATTRIBUTES.add("homepostofficebox");
|
|
CONTACT_ATTRIBUTES.add("l");
|
|
CONTACT_ATTRIBUTES.add("manager");
|
|
CONTACT_ATTRIBUTES.add("mobile");
|
|
CONTACT_ATTRIBUTES.add("namesuffix");
|
|
CONTACT_ATTRIBUTES.add("nickname");
|
|
CONTACT_ATTRIBUTES.add("o");
|
|
CONTACT_ATTRIBUTES.add("pager");
|
|
CONTACT_ATTRIBUTES.add("personaltitle");
|
|
CONTACT_ATTRIBUTES.add("postalcode");
|
|
CONTACT_ATTRIBUTES.add("postofficebox");
|
|
CONTACT_ATTRIBUTES.add("profession");
|
|
CONTACT_ATTRIBUTES.add("roomnumber");
|
|
CONTACT_ATTRIBUTES.add("secretarycn");
|
|
CONTACT_ATTRIBUTES.add("sn");
|
|
CONTACT_ATTRIBUTES.add("spousecn");
|
|
CONTACT_ATTRIBUTES.add("st");
|
|
CONTACT_ATTRIBUTES.add("street");
|
|
CONTACT_ATTRIBUTES.add("telephoneNumber");
|
|
CONTACT_ATTRIBUTES.add("title");
|
|
CONTACT_ATTRIBUTES.add("description");
|
|
CONTACT_ATTRIBUTES.add("im");
|
|
CONTACT_ATTRIBUTES.add("middlename");
|
|
CONTACT_ATTRIBUTES.add("lastmodified");
|
|
CONTACT_ATTRIBUTES.add("otherstreet");
|
|
CONTACT_ATTRIBUTES.add("otherstate");
|
|
CONTACT_ATTRIBUTES.add("otherpostofficebox");
|
|
CONTACT_ATTRIBUTES.add("otherpostalcode");
|
|
CONTACT_ATTRIBUTES.add("othercountry");
|
|
CONTACT_ATTRIBUTES.add("othercity");
|
|
CONTACT_ATTRIBUTES.add("haspicture");
|
|
CONTACT_ATTRIBUTES.add("keywords");
|
|
|
|
CONTACT_ATTRIBUTES.add("private");
|
|
CONTACT_ATTRIBUTES.add("sensitivity");
|
|
}
|
|
|
|
/**
|
|
* Get extended address book information for person with gallookup.
|
|
* Does not work with Exchange 2007
|
|
*
|
|
* @param person person attributes map
|
|
*/
|
|
public void galLookup(Map<String, String> person) {
|
|
if (!disableGalLookup) {
|
|
GetMethod getMethod = null;
|
|
try {
|
|
getMethod = new GetMethod(URIUtil.encodePathQuery(getCmdBasePath() + "?Cmd=gallookup&ADDR=" + person.get("EM")));
|
|
DavGatewayHttpClientFacade.executeGetMethod(httpClient, getMethod, true);
|
|
Map<String, Map<String, String>> results = XMLStreamUtil.getElementContentsAsMap(getMethod.getResponseBodyAsStream(), "person", "alias");
|
|
// add detailed information
|
|
if (!results.isEmpty()) {
|
|
Map<String, String> fullperson = results.get(person.get("AN").toLowerCase());
|
|
if (fullperson != null) {
|
|
for (Map.Entry<String, String> entry : fullperson.entrySet()) {
|
|
person.put(entry.getKey(), entry.getValue());
|
|
}
|
|
}
|
|
}
|
|
} catch (IOException e) {
|
|
LOGGER.warn("Unable to gallookup person: " + person + ", disable GalLookup");
|
|
disableGalLookup = true;
|
|
} finally {
|
|
if (getMethod != null) {
|
|
getMethod.releaseConnection();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get freebusy info for attendee between start and end date.
|
|
*
|
|
* @param attendee attendee email
|
|
* @param startDateValue start date
|
|
* @param endDateValue end date
|
|
* @return FreeBusy info
|
|
* @throws IOException on error
|
|
*/
|
|
public FreeBusy getFreebusy(String attendee, String startDateValue, String endDateValue) throws IOException {
|
|
attendee = replaceIcal4Principal(attendee);
|
|
if (attendee.startsWith("mailto:") || attendee.startsWith("MAILTO:")) {
|
|
attendee = attendee.substring("mailto:".length());
|
|
}
|
|
|
|
SimpleDateFormat exchangeZuluDateFormat = getExchangeZuluDateFormat();
|
|
SimpleDateFormat icalDateFormat = getZuluDateFormat();
|
|
|
|
String freebusyUrl;
|
|
Date startDate;
|
|
Date endDate;
|
|
try {
|
|
if (startDateValue.length() == 8) {
|
|
startDate = parseDate(startDateValue);
|
|
} else {
|
|
startDate = icalDateFormat.parse(startDateValue);
|
|
}
|
|
if (endDateValue.length() == 8) {
|
|
endDate = parseDate(endDateValue);
|
|
} else {
|
|
endDate = icalDateFormat.parse(endDateValue);
|
|
}
|
|
freebusyUrl = publicFolderUrl + "/?cmd=freebusy" +
|
|
"&start=" + exchangeZuluDateFormat.format(startDate) +
|
|
"&end=" + exchangeZuluDateFormat.format(endDate) +
|
|
"&interval=" + FREE_BUSY_INTERVAL +
|
|
"&u=SMTP:" + attendee;
|
|
} catch (ParseException e) {
|
|
throw new DavMailException("EXCEPTION_INVALID_DATES", e.getMessage());
|
|
}
|
|
|
|
FreeBusy freeBusy = null;
|
|
GetMethod getMethod = new GetMethod(freebusyUrl);
|
|
getMethod.setRequestHeader("Content-Type", "text/xml");
|
|
|
|
try {
|
|
DavGatewayHttpClientFacade.executeGetMethod(httpClient, getMethod, true);
|
|
String fbdata = StringUtil.getLastToken(getMethod.getResponseBodyAsString(), "<a:fbdata>", "</a:fbdata>");
|
|
if (fbdata != null) {
|
|
freeBusy = new FreeBusy(icalDateFormat, startDate, fbdata);
|
|
}
|
|
} finally {
|
|
getMethod.releaseConnection();
|
|
}
|
|
|
|
if (freeBusy != null && freeBusy.knownAttendee) {
|
|
return freeBusy;
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Exchange to iCalendar Free/Busy parser.
|
|
* Free time returns 0, Tentative returns 1, Busy returns 2, and Out of Office (OOF) returns 3
|
|
*/
|
|
public static final class FreeBusy {
|
|
final SimpleDateFormat icalParser;
|
|
boolean knownAttendee = true;
|
|
static final HashMap<Character, String> FBTYPES = new HashMap<Character, String>();
|
|
|
|
static {
|
|
FBTYPES.put('1', "BUSY-TENTATIVE");
|
|
FBTYPES.put('2', "BUSY");
|
|
FBTYPES.put('3', "BUSY-UNAVAILABLE");
|
|
}
|
|
|
|
final HashMap<String, StringBuilder> busyMap = new HashMap<String, StringBuilder>();
|
|
|
|
StringBuilder getBusyBuffer(char type) {
|
|
String fbType = FBTYPES.get(Character.valueOf(type));
|
|
StringBuilder buffer = busyMap.get(fbType);
|
|
if (buffer == null) {
|
|
buffer = new StringBuilder();
|
|
busyMap.put(fbType, buffer);
|
|
}
|
|
return buffer;
|
|
}
|
|
|
|
void startBusy(char type, Calendar currentCal) {
|
|
if (type == '4') {
|
|
knownAttendee = false;
|
|
} else if (type != '0') {
|
|
StringBuilder busyBuffer = getBusyBuffer(type);
|
|
if (busyBuffer.length() > 0) {
|
|
busyBuffer.append(',');
|
|
}
|
|
busyBuffer.append(icalParser.format(currentCal.getTime()));
|
|
}
|
|
}
|
|
|
|
void endBusy(char type, Calendar currentCal) {
|
|
if (type != '0' && type != '4') {
|
|
getBusyBuffer(type).append('/').append(icalParser.format(currentCal.getTime()));
|
|
}
|
|
}
|
|
|
|
FreeBusy(SimpleDateFormat icalParser, Date startDate, String fbdata) {
|
|
this.icalParser = icalParser;
|
|
if (fbdata.length() > 0) {
|
|
Calendar currentCal = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
|
|
currentCal.setTime(startDate);
|
|
|
|
startBusy(fbdata.charAt(0), currentCal);
|
|
for (int i = 1; i < fbdata.length() && knownAttendee; i++) {
|
|
currentCal.add(Calendar.MINUTE, FREE_BUSY_INTERVAL);
|
|
char previousState = fbdata.charAt(i - 1);
|
|
char currentState = fbdata.charAt(i);
|
|
if (previousState != currentState) {
|
|
endBusy(previousState, currentCal);
|
|
startBusy(currentState, currentCal);
|
|
}
|
|
}
|
|
currentCal.add(Calendar.MINUTE, FREE_BUSY_INTERVAL);
|
|
endBusy(fbdata.charAt(fbdata.length() - 1), currentCal);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Append freebusy information to buffer.
|
|
*
|
|
* @param buffer String buffer
|
|
*/
|
|
public void appendTo(StringBuilder buffer) {
|
|
for (Map.Entry<String, StringBuilder> entry : busyMap.entrySet()) {
|
|
buffer.append("FREEBUSY;FBTYPE=").append(entry.getKey())
|
|
.append(':').append(entry.getValue()).append((char) 13).append((char) 10);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Timezone structure
|
|
*/
|
|
public static final class VTimezone {
|
|
/**
|
|
* Timezone iCalendar body
|
|
*/
|
|
public String timezoneBody;
|
|
/**
|
|
* Timezone id
|
|
*/
|
|
public String timezoneId;
|
|
|
|
}
|
|
|
|
protected VTimezone vTimezone;
|
|
|
|
/**
|
|
* Load and return current user OWA timezone.
|
|
*
|
|
* @return current timezone
|
|
*/
|
|
public VTimezone getVTimezone() {
|
|
if (vTimezone == null) {
|
|
// need to load Timezone info from OWA
|
|
loadVtimezone();
|
|
}
|
|
return vTimezone;
|
|
}
|
|
|
|
protected abstract void loadVtimezone();
|
|
|
|
/**
|
|
* Return internal HttpClient instance
|
|
*
|
|
* @return http client
|
|
*/
|
|
public HttpClient getHttpClient() {
|
|
return httpClient;
|
|
}
|
|
}
|