uk.org.retep.xmpp.muc.room.NicknameChangedBroadcast Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2010, Peter T Mount

 * All rights reserved.
 *
 * 
 *   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 3 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, see .
 * 
 *
 * 
 *        GNU GENERAL PUBLIC LICENSE - CLASSPATH EXCEPTION
 * 
 *
 * 
 *   Linking this library statically or dynamically with other modules
 *   is making a combined work based on this library. Thus, the terms
 *   and conditions of the GNU General Public License cover the whole
 *   combination.
 * 
 *
 * 
 *   As a special exception, the copyright holders of this library give
 *   you permission to link this library with independent modules to
 *   produce an executable, regardless of the license terms of these
 *   independent modules, and to copy and distribute the resulting
 *   executable under terms of your choice, provided that you also meet,
 *   for each linked independent module, the terms and conditions of the
 *   license of that module.
 * 
 *
 * 
 *   An independent module is a module which is either not derived from or based
 *   on this library, or a module who's classes extend those within this library
 *   as part of the implementation of the library.
 * 
 *
 * 
 *   If you modify this library, you may extend this exception to your version
 *   of the library, but you are not obligated to do so. If you do not wish to
 *   do so, delete this exception statement from your version.
 * 
 */
package uk.org.retep.xmpp.muc.room;

import uk.org.retep.util.messaging.MessageException;
import uk.org.retep.xmpp.JID;
import uk.org.retep.xmpp.XMPPServer;
import uk.org.retep.xmpp.message.PresenceBuilder;
import uk.org.retep.xmpp.logic.XMPPLogic;
import uk.org.retep.xmpp.message.Presence;
import uk.org.retep.xmpp.muc.MucFeature;
import uk.org.retep.xmpp.muc.MucRoom;
import uk.org.retep.xmpp.muc.MucRoomMember;
import uk.org.retep.xmpp.muc.MucService;
import static uk.org.retep.xmpp.XMPPConstants.*;

/**
 * {@link XMPPLogic} implementation created by another to generate responses
 * for when a user joins a chat room
 * 
 * @author peter
 */
public class NicknameChangedBroadcast
        extends AbstractRoomBroadcast
{

    private final JID chatRoomJid;
    private final MucRoomMember joiningMember;
    private final JID userJid;
    private final String requestedNickName;
    private final String nickName;
    private final String oldNick;

    public NicknameChangedBroadcast( final JID chatRoomJid,
                                     final MucRoomMember joiningMember,
                                     final JID userJid,
                                     final String requestedNickName,
                                     final String nickName,
                                     final String oldNick )
    {
        this.chatRoomJid = chatRoomJid;
        this.joiningMember = joiningMember;
        this.userJid = userJid;
        this.requestedNickName = requestedNickName;
        this.nickName = nickName;
        this.oldNick = oldNick;
    }

    @Override
    public  XMPPLogic process( final XMPPServer server,
                                  final MucService service,
                                  final MucRoom room,
                                  final Presence presence )
            throws MessageException
    {
        // 7.3 ex42 Changing nickname, so send unavailable to members for old nickname
        getLog().info( "%s entered %s and changed nick from %s to %s",
                       userJid,
                       chatRoomJid,
                       oldNick,
                       nickName );

        final JID oldJid = oldNick == null ? null : chatRoomJid.copyWithoutResource().setResource(
                oldNick );

        final boolean roomNonAnon = room.hasFeature( MucFeature.MUC_NONANONYMOUS );

        PresenceBuilder response = null;

        // Send unavailable presence for the old nick with the new nick in the item
        for( MucRoomMember member : room.getMembers() )
        {
            if( !member.equals( joiningMember ) )
            {
                response = presence.builder().setFrom( oldJid ).setTo( member.getJID() ).setType( UNAVAILABLE );

                addMembershipItem( response, joiningMember, roomNonAnon, nickName ).addStatus( MEMBER_NICK_CHANGED );

                addPersistentNickName( response, joiningMember );

                server.send( response );
            }
        }

        // Send the users own unavailable presence last
        response = presence.builder().setFrom( oldJid ).setTo( joiningMember.getJID() ).setType( UNAVAILABLE );

        addMembershipItem( response, joiningMember, roomNonAnon, nickName ).
                addStatus( MEMBER_NICK_CHANGED ).
                addStatus( PRESENCE_OWN_PRESENCE );

        addPersistentNickName( response, joiningMember );

        server.send( response );

        // Send available presence with the new nick
        for( MucRoomMember member : room.getMembers() )
        {
            if( !member.equals( joiningMember ) )
            {
                response = presence.builder().setFrom( chatRoomJid ).setTo( member.getJID() );

                addMembershipItem( response, joiningMember, roomNonAnon, null );

                server.send( response );
            }
        }

        // Send users own available presence last
        response = presence.builder().setFrom( chatRoomJid ).setTo( joiningMember.getJID() );

        addMembershipItem( response, joiningMember, roomNonAnon, null ).addStatus( PRESENCE_OWN_PRESENCE );

        addPersistentNickName( response, joiningMember );

        server.send( response );

        return null;
    }
}