/*
* Copyright (C) 2004-2009 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.muc;
import org.xmpp.packet.JID;
import java.util.Map;
/**
* Gives the implementer the ability to react to, allow, or deny MUC related events.
*
* For example:
* - Event: a user tries to join a room
* Reaction: the delegate decides to allow or deny the user from joining
*
* @author Armando Jagucki
*/
public abstract class MUCEventDelegate {
public enum InvitationResult {
HANDLED_BY_DELEGATE,
HANDLED_BY_OPENFIRE,
REJECTED
};
public enum InvitationRejectionResult {
HANDLED_BY_DELEGATE,
HANDLED_BY_OPENFIRE,
};
/**
* This event will be triggered when an entity joins an existing room.
*
* Returns true if the user is allowed to join the room.
*
* @param room the MUC room.
* @param userjid the JID of the user attempting to join the room.
* @return true if the user is allowed to join the room.
*/
public abstract boolean joiningRoom(MUCRoom room, JID userjid);
/**
* This event will be triggered when an entity attempts to invite someone to a room.
*
* Returns a String indicating whether the invitation should be abandoned, handled by the delegate, or handled by openfire.
*
* @param room the MUC room.
* @param inviteeJID the JID of the user the invitation will be sent to.
* @param inviterJID the JID of the user that is sending the invitation
* @param inviteMessage the (optional) message that is sent explaining the invitation
* @return true if the user is allowed to join the room.
*/
public abstract InvitationResult sendingInvitation(MUCRoom room, JID inviteeJID, JID inviterJID, String inviteMessage);
/**
* This event will be triggered when an entity reject invite from someone to a room.
*
* Returns a String indicating whether the invitation should be abandoned, handled by the delegate, or handled by openfire.
*
* @param room the MUC room.
* @param to the JID of the user the rejecting of invitation will be sent to.
* @param from the JID of the user that is sending the rejecting of invitation
* @param reason the (optional) message that is sent explaining the rejection invitation
* @return true if the user is allowed to join the room.
*/
public abstract InvitationRejectionResult sendingInvitationRejection(MUCRoom room, JID to, JID from, String reason);
/**
* Returns a map containing room configuration variables and values.
*
* @param roomName the name of the room the configuration map is associated with.
* @return a map containing room configuration variables and values, or null if roomName was not valid.
*/
public abstract Map<String, String> getRoomConfig(String roomName);
/**
* This event will be triggered when an entity attempts to destroy a room.
*
* Returns true if the user is allowed to destroy the room.
*
* @param roomName the name of the MUC room being destroyed.
* @param userjid the JID of the user attempting to destroy the room.
* @return true if the user is allowed to destroy the room.
*/
public abstract boolean destroyingRoom(String roomName, JID userjid);
/**
* Returns true if the room that is not present in the server should have existed and needs
* to be recreated.
*
* @param roomName name of the room.
* @param userjid JID Of the user trying to join/create the room.
* @return true if the room that is not present in the server should have existed and needs
* to be recreated.
*/
public abstract boolean shouldRecreate(String roomName, JID userjid);
/**
* Loads a delegate provided room configuration for the room specified.
*
* @param room the room to load the configuration for.
* @return true if the room configuration was received from the delegate and applied to the room.
*/
public boolean loadConfig(MUCRoom room) {
Map<String, String> roomConfig = getRoomConfig(room.getName());
if (roomConfig != null) {
room.setNaturalLanguageName(roomConfig.get("muc#roomconfig_roomname"));
room.setDescription(roomConfig.get("muc#roomconfig_roomdesc"));
room.setCanOccupantsChangeSubject("1".equals(roomConfig.get("muc#roomconfig_changesubject")));
room.setMaxUsers(Integer.parseInt(roomConfig.get("muc#roomconfig_maxusers")));
room.setPublicRoom("1".equals(roomConfig.get("muc#roomconfig_publicroom")));
room.setCanOccupantsInvite("1".equals(roomConfig.get("muc#roomconfig_allowinvites")));
room.setCanAnyoneDiscoverJID("anyone".equals(roomConfig.get("muc#roomconfig_whois")));
room.setCanSendPrivateMessage( roomConfig.get("muc#roomconfig_allowpm") );
room.setChangeNickname("1".equals(roomConfig.get("x-muc#roomconfig_canchangenick")));
room.setRegistrationEnabled("1".equals(roomConfig.get("x-muc#roomconfig_registration")));
room.setPersistent("1".equals(roomConfig.get("muc#roomconfig_persistentroom")));
final String property = roomConfig.get("muc#roomconfig_roomowners");
if (property != null) {
String jids[] = property.split(",");
for (String jid : jids) {
if (jid != null && jid.trim().length() != 0) {
room.addFirstOwner(new JID(jid.trim().toLowerCase()).asBareJID());
}
}
}
try {
room.unlock(room.getRole());
} catch (ForbiddenException e) {
return false;
}
}
return roomConfig != null;
}
}