/*
* Copyright (C) 2005-2008 Jive Software. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jivesoftware.openfire.plugin;
import org.jivesoftware.openfire.PresenceRouter;
import org.jivesoftware.openfire.XMPPServer;
import org.jivesoftware.openfire.container.Plugin;
import org.jivesoftware.openfire.container.PluginManager;
import org.jivesoftware.openfire.interceptor.InterceptorManager;
import org.jivesoftware.openfire.interceptor.PacketInterceptor;
import org.jivesoftware.openfire.interceptor.PacketRejectedException;
import org.jivesoftware.openfire.session.Session;
import org.jivesoftware.util.JiveGlobals;
import org.xmpp.packet.JID;
import org.xmpp.packet.Packet;
import org.xmpp.packet.Presence;
import org.xmpp.packet.Presence.Type;
import java.io.File;
import java.util.*;
/**
* This plugin can be configuured to automatically accept or reject subscription
* requests. When set to accept subscription requests users will be able to add
* someone to their roster without having to wait for a manual subscription
* acceptance from the other person. Conversely, when the plugin is set to
* reject subscription requests users will not be able to add people to their
* roster.
*
* @author <a href="mailto:ryan@version2software.com">Ryan Graham</a>
*/
public class SubscriptionPlugin implements Plugin {
public static final String DISABLED = "disabled";
public static final String ACCEPT = "accept";
public static final String REJECT = "reject";
public static final String LOCAL = "local";
public static final String ALL = "all";
private static final String SUBSCRIPTION_TYPE = "plugin.subscription.type";
private static final String SUBSCRIPTION_LEVEL = "plugin.subscription.level";
private static final String WHITE_LIST = "plugin.subscription.whiteList";
private List<String> whiteList = new ArrayList<String>();
private SuscriptionPacketInterceptor interceptor = new SuscriptionPacketInterceptor();
private PresenceRouter router;
private String serverName;
public SubscriptionPlugin() {
XMPPServer server = XMPPServer.getInstance();
router = server.getPresenceRouter();
serverName = server.getServerInfo().getXMPPDomain();
String list = JiveGlobals.getProperty(WHITE_LIST);
if (list != null) {
whiteList.addAll(csvToList(list));
}
}
public void initializePlugin(PluginManager manager, File pluginDirectory) {
InterceptorManager.getInstance().addInterceptor(interceptor);
}
public void destroyPlugin() {
InterceptorManager.getInstance().removeInterceptor(interceptor);
interceptor = null;
router = null;
serverName = null;
whiteList = null;
}
public void setSubscriptionType(String type) {
JiveGlobals.setProperty(SUBSCRIPTION_TYPE, type);
}
public String getSubscriptionType() {
return JiveGlobals.getProperty(SUBSCRIPTION_TYPE, DISABLED);
}
public void setSubscriptionLevel(String level) {
JiveGlobals.setProperty(SUBSCRIPTION_LEVEL, level);
}
public String getSubscriptionLevel() {
return JiveGlobals.getProperty(SUBSCRIPTION_LEVEL, LOCAL);
}
public Collection<String> getWhiteListUsers() {
Collections.sort(whiteList);
return whiteList;
}
public void addWhiteListUser(String user) {
if (!whiteList.contains(user.trim().toLowerCase())) {
whiteList.add(user.trim().toLowerCase());
JiveGlobals.setProperty(WHITE_LIST, listToCSV(whiteList));
}
}
public void removeWhiteListUser(String user) {
whiteList.remove(user.trim().toLowerCase());
if (whiteList.size() == 0) {
JiveGlobals.deleteProperty(WHITE_LIST);
}
else {
JiveGlobals.setProperty(WHITE_LIST, listToCSV(whiteList));
}
}
private String listToCSV(List<String> list) {
StringBuilder sb = new StringBuilder();
Iterator<String> iter = list.iterator();
while (iter.hasNext()) {
String s = iter.next();
sb.append(s);
if (iter.hasNext()) {
sb.append(",");
}
}
return sb.toString();
}
private List<String> csvToList(String csv) {
List<String> list = new ArrayList<String>();
list.addAll(Arrays.asList(csv.split(",")));
return list;
}
private class SuscriptionPacketInterceptor implements PacketInterceptor {
public void interceptPacket(Packet packet, Session session, boolean incoming, boolean processed) throws PacketRejectedException {
String type = getSubscriptionType();
if (type.equals(DISABLED)) {
return;
}
if ((packet instanceof Presence) && !incoming && !processed) {
Presence presencePacket = (Presence) packet;
Type presenceType = presencePacket.getType();
if (presenceType != null && presenceType.equals(Presence.Type.subscribe)) {
JID toJID = presencePacket.getTo();
JID fromJID = presencePacket.getFrom();
String toNode = toJID.getNode();
if (whiteList.contains(toNode)) {
return;
}
if (type.equals(ACCEPT)) {
acceptSubscription(toJID, fromJID);
}
if (type.equals(REJECT)) {
rejectSubscription(toJID, fromJID);
}
}
}
}
private void acceptSubscription(JID toJID, JID fromJID) throws PacketRejectedException {
if (getSubscriptionLevel().equals(LOCAL)) {
String toDomain = toJID.getDomain();
String fromDomain = fromJID.getDomain();
if (!toDomain.equals(serverName) || !fromDomain.equals(serverName)) {
return;
}
}
// Simulate that the target user has accepted the presence subscription request
Presence presence = new Presence();
presence.setType(Presence.Type.subscribed);
presence.setTo(fromJID);
presence.setFrom(toJID);
router.route(presence);
throw new PacketRejectedException();
}
private void rejectSubscription(JID toJID, JID fromJID) throws PacketRejectedException {
if (getSubscriptionLevel().equals(LOCAL)) {
String toDomain = toJID.getDomain();
String fromDomain = fromJID.getDomain();
if (toDomain.equals(serverName) && fromDomain.equals(serverName)) {
return;
}
}
// Simulate that the target user has rejected the presence subscription request
Presence presence = new Presence();
presence.setType(Presence.Type.unsubscribed);
// This is to get around an issue in Spark
// (http://www.igniterealtime.org/issues/browse/SPARK-300).
// Unfortunately, this is a bit of a hack and can easily be defeated
// if a user changes their resource when using Spark.
if (JiveGlobals.getBooleanProperty("plugin.subscription.sparkCheck", false)) {
String resource = fromJID.getResource();
if (resource != null && resource.equalsIgnoreCase("Spark")) {
presence.setType(Presence.Type.unsubscribed);
}
}
presence.setTo(fromJID);
presence.setFrom(toJID);
router.route(presence);
throw new PacketRejectedException();
}
}
}