/**
* Returns the Clearspace username of the user by id.
*
* @param id ID to retrieve Username of.
* @return The username of the user in Clearspace.
* @throws org.jivesoftware.openfire.user.UserNotFoundException If the user was not found.
*/
protected String getUsernameByID(Long id) throws UserNotFoundException {
// Checks if it is in the cache
if (usernameCache.containsKey(id)) {
return usernameCache.get(id);
}
// Gets the user's ID from Clearspace
try {
String path = ClearspaceUserProvider.USER_URL_PREFIX + "usersByID/" + id;
Element element =
executeRequest(org.jivesoftware.openfire.clearspace.ClearspaceManager.HttpType.GET, path);
String username =
WSUtils.getElementText(
element.selectSingleNode("return"), "username"); // TODO: is this right?
// Escape the username so that it can be used as a JID.
username = JID.escapeNode(username);
usernameCache.put(id, username);
return username;
} catch (UserNotFoundException unfe) {
// It is a supported exception, throw it again
throw unfe;
} catch (Exception e) {
// It is not a supported exception, wrap it into a UserNotFoundException
throw new UserNotFoundException("Unexpected error", e);
}
}
/**
* If CS throws an exception it handled and transalated to a Openfire exception if possible. This
* is done using <code>exceptionMap</code> that has a mapping from CS to OF. If no mapping is
* found then it tries to instantiete the original exception. If this fails it throws a <code>
* Exception</code> with the message of the CS exception.
*
* @param response the response from CS to check if it is an exception message.
* @throws Exception if the response is an exception message.
*/
private void checkFault(Element response) throws Exception {
Node node = response.selectSingleNode("ns1:faultstring");
if (node != null) {
String exceptionText = node.getText();
// Text accepted samples:
// 'java.lang.Exception: Exception message'
// 'java.lang.Exception'
// Get the exception class and message if any
int index = exceptionText.indexOf(":");
String className;
String message;
// If there is no message, save the class only
if (index == -1) {
className = exceptionText;
message = null;
} else {
// Else save both
className = exceptionText.substring(0, index);
message = exceptionText.substring(index + 2);
}
// Map the exception to a Openfire one, if possible
if (exceptionMap.containsKey(className)) {
className = exceptionMap.get(className);
}
// Tries to create an instance with the message
Exception exception;
try {
Class exceptionClass = Class.forName(className);
if (message == null) {
exception = (Exception) exceptionClass.newInstance();
} else {
Constructor constructor = exceptionClass.getConstructor(String.class);
exception = (Exception) constructor.newInstance(message);
}
} catch (Exception e) {
// failed to create an specific exception, creating a standard one.
exception = new Exception(exceptionText);
}
throw exception;
}
}
/**
* Returns the Clearspace user id the user by username.
*
* @param username Username to retrieve ID of.
* @return The ID number of the user in Clearspace.
* @throws org.jivesoftware.openfire.user.UserNotFoundException If the user was not found.
*/
protected long getUserID(String username) throws UserNotFoundException {
// Gets the part before of @ of the username param
if (username.contains("@")) {
// User's id are only for local users
if (!XMPPServer.getInstance().isLocal(new JID(username))) {
throw new UserNotFoundException("Cannot load user of remote server: " + username);
}
username = username.substring(0, username.lastIndexOf("@"));
}
// Checks if it is in the cache
if (userIDCache.containsKey(username)) {
return userIDCache.get(username);
}
// Un-escape username.
String unescapedUsername = JID.unescapeNode(username);
// Encode potentially non-ASCII characters
unescapedUsername = URLUTF8Encoder.encode(unescapedUsername);
// Gets the user's ID from Clearspace
try {
String path = ClearspaceUserProvider.USER_URL_PREFIX + "users/" + unescapedUsername;
Element element =
executeRequest(org.jivesoftware.openfire.clearspace.ClearspaceManager.HttpType.GET, path);
Long id = Long.valueOf(WSUtils.getElementText(element.selectSingleNode("return"), "ID"));
userIDCache.put(username, id);
return id;
} catch (UserNotFoundException unfe) {
// It is a supported exception, throw it again
throw unfe;
} catch (Exception e) {
// It is not a supported exception, wrap it into a UserNotFoundException
throw new UserNotFoundException("Unexpected error", e);
}
}
/**
* Sets the URI of the Clearspace service; e.g., <tt>https://localhost:80/clearspace</tt>. This
* value is stored as the Jive Property <tt>clearspace.uri</tt>.
*
* @param uri the Clearspace service URI.
*/
public void setConnectionURI(String uri) {
if (!uri.endsWith("/")) {
uri = uri + "/";
}
this.uri = uri;
properties.put("clearspace.uri", uri);
// Updates the host/port attributes
updateHostPort();
if (isEnabled()) {
startClearspaceConfig();
}
}
/**
* Returns the Clearspace group id of the group.
*
* @param groupname Name of the group to retrieve ID of.
* @return The ID number of the group in Clearspace.
* @throws org.jivesoftware.openfire.group.GroupNotFoundException If the group was not found.
*/
protected long getGroupID(String groupname) throws GroupNotFoundException {
if (groupIDCache.containsKey(groupname)) {
return groupIDCache.get(groupname);
}
try {
// Encode potentially non-ASCII characters
groupname = URLUTF8Encoder.encode(groupname);
String path = ClearspaceGroupProvider.URL_PREFIX + "groups/" + groupname;
Element element =
executeRequest(org.jivesoftware.openfire.clearspace.ClearspaceManager.HttpType.GET, path);
Long id = Long.valueOf(WSUtils.getElementText(element.selectSingleNode("return"), "ID"));
// Saves it into the cache
groupIDCache.put(groupname, id);
return id;
} catch (GroupNotFoundException gnfe) {
// It is a supported exception, throw it again
throw gnfe;
} catch (Exception e) {
// It is not a supported exception, wrap it into a GroupNotFoundException
throw new GroupNotFoundException("Unexpected error", e);
}
}
/**
* Sets the shared secret for the Clearspace service we're connecting to.
*
* @param sharedSecret the password configured in Clearspace to authenticate Openfire.
*/
public void setSharedSecret(String sharedSecret) {
// Set new password for external component
ExternalComponentConfiguration configuration =
new ExternalComponentConfiguration(
"clearspace", true, ExternalComponentConfiguration.Permission.allowed, sharedSecret);
try {
ExternalComponentManager.allowAccess(configuration);
} catch (ModificationNotAllowedException e) {
Log.warn("Failed to configure password for Clearspace", e);
}
// After updating the component information we can update the field, but not before.
// If it is done before, OF won't be able to execute the updateSharedsecret webservice
// since it would try with the new password.
this.sharedSecret = sharedSecret;
properties.put("clearspace.sharedSecret", sharedSecret);
}
static {
try {
factory = XmlPullParserFactory.newInstance(MXParser.class.getName(), null);
factory.setNamespaceAware(true);
} catch (XmlPullParserException e) {
Log.error("Error creating a parser factory", e);
}
// Create xmpp parser to keep in each thread
localParser =
new ThreadLocal<XMPPPacketReader>() {
protected XMPPPacketReader initialValue() {
XMPPPacketReader parser = new XMPPPacketReader();
factory.setNamespaceAware(true);
parser.setXPPFactory(factory);
return parser;
}
};
// Add a new exception map from CS to OF and it will be automatically translated.
exceptionMap = new HashMap<String, String>();
exceptionMap.put(
"com.jivesoftware.base.UserNotFoundException",
"org.jivesoftware.openfire.user.UserNotFoundException");
exceptionMap.put(
"com.jivesoftware.base.UserAlreadyExistsException",
"org.jivesoftware.openfire.user.UserAlreadyExistsException");
exceptionMap.put(
"com.jivesoftware.base.GroupNotFoundException",
"org.jivesoftware.openfire.group.GroupNotFoundException");
exceptionMap.put(
"com.jivesoftware.base.GroupAlreadyExistsException",
"org.jivesoftware.openfire.group.GroupAlreadyExistsException");
exceptionMap.put(
"org.acegisecurity.BadCredentialsException",
"org.jivesoftware.openfire.auth.UnauthorizedException");
exceptionMap.put(
"com.jivesoftware.base.UnauthorizedException",
"org.jivesoftware.openfire.auth.UnauthorizedException");
exceptionMap.put(
"com.jivesoftware.community.NotFoundException", "org.jivesoftware.util.NotFoundException");
}
private void init() {
// Register the trust manager to use when using HTTPS
Protocol easyhttps =
new Protocol("https", (ProtocolSocketFactory) new SSLProtocolSocketFactory(this), 443);
Protocol.registerProtocol("https", easyhttps);
// Convert XML based provider setup to Database based
JiveGlobals.migrateProperty("clearspace.uri");
JiveGlobals.migrateProperty("clearspace.sharedSecret");
// Make sure that all Clearspace components are set up, unless they were overridden
// Note that the auth provider is our way of knowing that we are set up with Clearspace,
// so don't bother checking to set it.
if (isEnabled()) {
if (JiveGlobals.getProperty("provider.user.className") == null) {
JiveGlobals.setProperty(
"provider.user.className",
"org.jivesoftware.openfire.clearspace.ClearspaceUserProvider");
}
if (JiveGlobals.getProperty("provider.group.className") == null) {
JiveGlobals.setProperty(
"provider.group.className",
"org.jivesoftware.openfire.clearspace.ClearspaceGroupProvider");
}
if (JiveGlobals.getProperty("provider.vcard.className") == null) {
JiveGlobals.setProperty(
"provider.vcard.className",
"org.jivesoftware.openfire.clearspace.ClearspaceVCardProvider");
}
if (JiveGlobals.getProperty("provider.lockout.className") == null) {
JiveGlobals.setProperty(
"provider.lockout.className",
"org.jivesoftware.openfire.clearspace.ClearspaceLockOutProvider");
}
if (JiveGlobals.getProperty("provider.securityAudit.className") == null) {
JiveGlobals.setProperty(
"provider.securityAudit.className",
"org.jivesoftware.openfire.clearspace.ClearspaceSecurityAuditProvider");
}
if (JiveGlobals.getProperty("provider.admin.className") == null) {
JiveGlobals.setProperty(
"provider.admin.className",
"org.jivesoftware.openfire.clearspace.ClearspaceAdminProvider");
}
}
this.uri = properties.get("clearspace.uri");
if (uri != null) {
if (!this.uri.endsWith("/")) {
this.uri = this.uri + "/";
}
// Updates the host/port attributes based on the uri
updateHostPort();
}
sharedSecret = properties.get("clearspace.sharedSecret");
// Creates the cache maps
userIDCache = new DefaultCache<String, Long>("clearspace.userid", 1000, JiveConstants.DAY);
groupIDCache = new DefaultCache<String, Long>("clearspace.groupid", 1000, JiveConstants.DAY);
usernameCache = new DefaultCache<Long, String>("clearspace.username", 1000, JiveConstants.DAY);
if (Log.isDebugEnabled()) {
StringBuilder buf = new StringBuilder();
buf.append("Created new ClearspaceManager() instance, fields:\n");
buf.append("\t URI: ").append(uri).append("\n");
buf.append("\t sharedSecret: ").append(sharedSecret).append("\n");
Log.debug("ClearspaceManager: " + buf.toString());
}
// Init nonce cache
nonceCache = CacheFactory.createCache("Clearspace SSO Nonce");
// Init nonce generator
nonceGenerator = new Random();
}
public void _jspService(HttpServletRequest request, HttpServletResponse response)
throws java.io.IOException, ServletException {
JspFactory _jspxFactory = null;
PageContext pageContext = null;
HttpSession session = null;
ServletContext application = null;
ServletConfig config = null;
JspWriter out = null;
Object page = this;
JspWriter _jspx_out = null;
PageContext _jspx_page_context = null;
try {
_jspxFactory = JspFactory.getDefaultFactory();
response.setContentType("text/html");
pageContext =
_jspxFactory.getPageContext(this, request, response, "error.jsp", true, 8192, true);
_jspx_page_context = pageContext;
application = pageContext.getServletContext();
config = pageContext.getServletConfig();
session = pageContext.getSession();
out = pageContext.getOut();
_jspx_out = out;
out.write("\n\n\n\n\n\n\n\n\n");
out.write('\n');
org.jivesoftware.util.WebManager webManager = null;
synchronized (_jspx_page_context) {
webManager =
(org.jivesoftware.util.WebManager)
_jspx_page_context.getAttribute("webManager", PageContext.PAGE_SCOPE);
if (webManager == null) {
webManager = new org.jivesoftware.util.WebManager();
_jspx_page_context.setAttribute("webManager", webManager, PageContext.PAGE_SCOPE);
}
}
out.write('\n');
webManager.init(request, response, session, application, out);
out.write('\n');
out.write('\n');
// Get paramters
boolean doTest = request.getParameter("test") != null;
boolean cancel = request.getParameter("cancel") != null;
boolean sent = ParamUtils.getBooleanParameter(request, "sent");
boolean success = ParamUtils.getBooleanParameter(request, "success");
String from = ParamUtils.getParameter(request, "from");
String to = ParamUtils.getParameter(request, "to");
String subject = ParamUtils.getParameter(request, "subject");
String body = ParamUtils.getParameter(request, "body");
// Cancel if requested
if (cancel) {
response.sendRedirect("system-email.jsp");
return;
}
// Variable to hold messaging exception, if one occurs
Exception mex = null;
// Validate input
Map<String, String> errors = new HashMap<String, String>();
if (doTest) {
if (from == null) {
errors.put("from", "");
}
if (to == null) {
errors.put("to", "");
}
if (subject == null) {
errors.put("subject", "");
}
if (body == null) {
errors.put("body", "");
}
EmailService service = EmailService.getInstance();
// Validate host - at a minimum, it needs to be set:
String host = service.getHost();
if (host == null) {
errors.put("host", "");
}
// if no errors, continue
if (errors.size() == 0) {
// Create a message
MimeMessage message = service.createMimeMessage();
// Set the date of the message to be the current date
SimpleDateFormat format =
new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss Z", java.util.Locale.US);
format.setTimeZone(JiveGlobals.getTimeZone());
message.setHeader("Date", format.format(new Date()));
// Set to and from.
message.setRecipient(Message.RecipientType.TO, new InternetAddress(to, null));
message.setFrom(new InternetAddress(from, null));
message.setSubject(subject);
message.setText(body);
// Send the message, wrap in a try/catch:
try {
service.sendMessagesImmediately(Collections.singletonList(message));
// success, so indicate this:
response.sendRedirect("system-emailtest.jsp?sent=true&success=true");
return;
} catch (MessagingException me) {
me.printStackTrace();
mex = me;
}
}
}
// Set var defaults
Collection<JID> jids = webManager.getXMPPServer().getAdmins();
User user = null;
if (!jids.isEmpty()) {
for (JID jid : jids) {
if (webManager.getXMPPServer().isLocal(jid)) {
user = webManager.getUserManager().getUser(jid.getNode());
if (user.getEmail() != null) {
break;
}
}
}
}
if (from == null) {
from = user.getEmail();
}
if (to == null) {
to = user.getEmail();
}
if (subject == null) {
subject = "Test email sent via Openfire";
}
if (body == null) {
body = "This is a test message.";
}
out.write("\n\n<html>\n <head>\n <title>");
if (_jspx_meth_fmt_message_0(_jspx_page_context)) return;
out.write(
"</title>\n <meta name=\"pageID\" content=\"system-email\"/>\n </head>\n <body>\n\n<script language=\"JavaScript\" type=\"text/javascript\">\nvar clicked = false;\nfunction checkClick(el) {\n if (!clicked) {\n clicked = true;\n return true;\n }\n return false;\n}\n</script>\n\n<p>\n");
if (_jspx_meth_fmt_message_1(_jspx_page_context)) return;
out.write("\n</p>\n\n");
if (JiveGlobals.getProperty("mail.smtp.host") == null) {
out.write(
"\n\n <div class=\"jive-error\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tbody>\n <tr>\n \t<td class=\"jive-icon\"><img src=\"images/error-16x16.gif\" width=\"16\" height=\"16\" border=\"0\" alt=\"\"></td>\n\t <td class=\"jive-icon-label\">\n\t\t ");
if (_jspx_meth_fmt_message_2(_jspx_page_context)) return;
out.write("\n\t </td>\n </tr>\n </tbody>\n </table>\n </div>\n\n");
}
out.write('\n');
out.write('\n');
if (doTest || sent) {
out.write("\n\n ");
if (success) {
out.write(
"\n\n <div class=\"jive-success\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tbody>\n <tr>\n \t<td class=\"jive-icon\"><img src=\"images/success-16x16.gif\" width=\"16\" height=\"16\" border=\"0\" alt=\"\"></td>\n \t<td class=\"jive-icon-label\">");
if (_jspx_meth_fmt_message_3(_jspx_page_context)) return;
out.write(
"</td>\n </tr>\n </tbody>\n </table>\n </div>\n\n ");
} else {
out.write(
"\n\n <div class=\"jive-error\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tbody>\n <tr><td class=\"jive-icon\"><img src=\"images/error-16x16.gif\" width=\"16\" height=\"16\" border=\"0\" alt=\"\"></td>\n <td class=\"jive-icon-label\">\n ");
if (_jspx_meth_fmt_message_4(_jspx_page_context)) return;
out.write("\n ");
if (mex != null) {
out.write("\n ");
if (mex instanceof AuthenticationFailedException) {
out.write("\n \t");
if (_jspx_meth_fmt_message_5(_jspx_page_context)) return;
out.write(" \n ");
} else {
out.write("\n (Message: ");
out.print(mex.getMessage());
out.write(")\n ");
}
out.write("\n ");
}
out.write(
"\n </td></tr>\n </tbody>\n </table>\n </div>\n\n ");
}
out.write("\n\n <br>\n\n");
}
out.write(
"\n\n<form action=\"system-emailtest.jsp\" method=\"post\" name=\"f\" onsubmit=\"return checkClick(this);\">\n\n<table cellpadding=\"3\" cellspacing=\"0\" border=\"0\">\n<tbody>\n <tr>\n <td>\n ");
if (_jspx_meth_fmt_message_6(_jspx_page_context)) return;
out.write(":\n </td>\n <td>\n ");
String host = JiveGlobals.getProperty("mail.smtp.host");
if (host == null) {
out.write("\n <i>");
if (_jspx_meth_fmt_message_7(_jspx_page_context)) return;
out.write("</i>\n ");
} else {
out.write("\n ");
out.print(host);
out.write(':');
out.print(JiveGlobals.getIntProperty("mail.smtp.port", 25));
out.write("\n\n ");
if (JiveGlobals.getBooleanProperty("mail.smtp.ssl", false)) {
out.write("\n\n (");
if (_jspx_meth_fmt_message_8(_jspx_page_context)) return;
out.write(")\n\n ");
}
out.write("\n ");
}
out.write("\n </td>\n </tr>\n <tr>\n <td>\n ");
if (_jspx_meth_fmt_message_9(_jspx_page_context)) return;
out.write(
":\n </td>\n <td>\n <input type=\"hidden\" name=\"from\" value=\"");
out.print(from);
out.write("\">\n ");
out.print(StringUtils.escapeHTMLTags(from));
out.write(
"\n <span class=\"jive-description\">\n (<a href=\"user-edit-form.jsp?username="******"\">Update Address</a>)\n </span>\n </td>\n </tr>\n <tr>\n <td>\n ");
if (_jspx_meth_fmt_message_10(_jspx_page_context)) return;
out.write(
":\n </td>\n <td>\n <input type=\"text\" name=\"to\" value=\"");
out.print(((to != null) ? to : ""));
out.write(
"\"\n size=\"40\" maxlength=\"100\">\n </td>\n </tr>\n <tr>\n <td>\n ");
if (_jspx_meth_fmt_message_11(_jspx_page_context)) return;
out.write(
":\n </td>\n <td>\n <input type=\"text\" name=\"subject\" value=\"");
out.print(((subject != null) ? subject : ""));
out.write(
"\"\n size=\"40\" maxlength=\"100\">\n </td>\n </tr>\n <tr valign=\"top\">\n <td>\n ");
if (_jspx_meth_fmt_message_12(_jspx_page_context)) return;
out.write(
":\n </td>\n <td>\n <textarea name=\"body\" cols=\"45\" rows=\"5\" wrap=\"virtual\">");
out.print(body);
out.write(
"</textarea>\n </td>\n </tr>\n <tr>\n <td colspan=\"2\">\n <br>\n <input type=\"submit\" name=\"test\" value=\"");
if (_jspx_meth_fmt_message_13(_jspx_page_context)) return;
out.write("\">\n <input type=\"submit\" name=\"cancel\" value=\"");
if (_jspx_meth_fmt_message_14(_jspx_page_context)) return;
out.write(
"\">\n </td>\n </tr>\n</tbody>\n</table>\n\n</form>\n\n </body>\n</html>");
} catch (Throwable t) {
if (!(t instanceof SkipPageException)) {
out = _jspx_out;
if (out != null && out.getBufferSize() != 0) out.clearBuffer();
if (_jspx_page_context != null) _jspx_page_context.handlePageException(t);
}
} finally {
if (_jspxFactory != null) _jspxFactory.releasePageContext(_jspx_page_context);
}
}