TNStropheRosterBase.j

/*
 * TNStropheRosterBase.j
 *
 * Copyright (C) 2010  Antoine Mercadal <antoine.mercadal@inframonde.eu>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

@import <Foundation/Foundation.j>

@import "TNStropheConnection.j"
@import "TNStropheContact.j"
@import "TNStropheGroup.j"
@import "TNStropheJID.j"
@import "TNStropheStanza.j"


/*! @ingroup strophecappuccino
    this is an implementation of the functionality shared between real rosters and MUC memberships
*/
@implementation TNStropheRosterBase : CPObject
{
    CPArray                 _contactCache   @accessors(getter=contactCache);
    CPArray                 _groupCache     @accessors(getter=groupCache);
    CPArray                 _content        @accessors(getter=content);
    id                      _delegate       @accessors(property=delegate);
    TNStropheConnection     _connection     @accessors(getter=connection);
}

#pragma mark -
#pragma mark Class methods

+ (id)rosterWithConnection:(TNStropheConnection)aConnection
{
    return [[TNStropheRosterBase alloc] initWithConnection:aConnection];
}

#pragma mark -
#pragma mark Initialization

/*! initialize a roster with a valid TNStropheConnection

    @return initialized instance of TNStropheRosterBase
*/
- (id)initWithConnection:(TNStropheConnection)aConnection
{
    if (self = [super init])
    {
        _connection     = aConnection;
        _content        = [CPArray array];
        _contactCache   = [CPArray array];
        _groupCache     = [CPArray array];
    }

    return self;
}

/*! sent disconnect message to the TNStropheConnection of the roster
*/
- (void)disconnect
{
    [_connection disconnect];
}

- (void)clear
{
    [_content removeAllObjects];
    [_contactCache removeAllObjects];
    [_groupCache removeAllObjects];
}


#pragma mark -
#pragma mark Contacts

/*! get an array with all cached contacts
*/
- (void)contacts
{
    return _contactCache;
}

/*! add contact to roster cache
    @param aContact the contact to add
*/
- (void)cacheContact:(TNStropheContact)aContact
{
    if (![_contactCache containsObject:aContact])
        [_contactCache addObject:aContact];
}

/*! remove a TNStropheContact from the roster cache
    @param aContact the contact to remove
*/
- (void)uncacheContact:(TNStropheContact)aContact
{
    [_contactCache removeObject:aContact];
}



/*! performs contactWithFullJID and contactWithBareJID
    @param aJID CPString containing the JID
    @return TNStropheContact the contact with the given JID
*/
- (TNStropheContact)contactWithJID:(TNStropheJID)aJID
{
    return [self contactWithFullJID:aJID] || [self contactWithBareJID:aJID];
}

/*! return a TNStropheContact object according to the given full JID
    @param aJID CPString containing the JID
    @return TNStropheContact the contact with the given JID
*/
- (TNStropheContact)contactWithFullJID:(TNStropheJID)aJID
{
    for (var i = 0; i < [_contactCache count]; i++)
        if ([[[_contactCache objectAtIndex:i] JID] fullEquals:aJID])
            return [_contactCache objectAtIndex:i];
    return nil;
}

/*! return a TNStropheContact object according to the given bare JID
    @param aJID CPString containing the JID
    @return TNStropheContact the contact with the given JID
*/
- (TNStropheContact)contactWithBareJID:(TNStropheJID)aJID
{
    for (var i = 0; i < [_contactCache count]; i++)
        if ([[[_contactCache objectAtIndex:i] JID] bareEquals:aJID])
            return [_contactCache objectAtIndex:i];
    return nil;
}

/*! perform containsFullJID and containsBareJID
    @param aJID the JID to search
*/
- (BOOL)containsJID:(TNStropheJID)aJID
{
    return ([self contactWithBareJID:aJID] || [self contactWithFullJID:aJID]);
}

/*! check if roster contains a contact with a given full JID
    @param aJID the JID to search
    @return YES is JID is in roster, NO otherwise
*/
- (BOOL)containsFullJID:(TNStropheJID)aJID
{
    return ([self contactWithFullJID:aJID]) ? YES : NO;
}

/*! check if roster contains a contact with a given bare JID
    @param aJID the JID to search
    @return YES is JID is in roster, NO otherwise
*/
- (BOOL)containsBareJID:(TNStropheJID)aJID
{
    return ([self contactWithBareJID:aJID]) ? YES : NO;
}

/*! changes the nickname of the contact with the given JID
    @param aName the new nickname
    @param aJID the JID of the contact to change the nickname
*/
- (void)changeNickname:(CPString)aName ofContact:(TNStropheContact)aContact
{
    [aContact setNickname:aName];
}

/*! changes the nickname of the contact with the given JID
    @param aName the new nickname
    @param aJID the JID of the contact to change the nickname
*/
- (void)changeNickname:(CPString)aName ofContactWithJID:(TNStropheJID)aJID
{
    [self changeNickname:aName ofContact:[self contactWithJID:aJID]];
}

@end