root/trunk/Models/JVBuddy.m

#import "JVBuddy.h"
#import "MVConnectionsController.h"

#import <ChatCore/NSStringAdditions.h>

NSString *JVBuddyCameOnlineNotification = @"JVBuddyCameOnlineNotification";
NSString *JVBuddyWentOfflineNotification = @"JVBuddyWentOfflineNotification";

NSString *JVBuddyUserCameOnlineNotification = @"JVBuddyUserCameOnlineNotification";
NSString *JVBuddyUserWentOfflineNotification = @"JVBuddyUserWentOfflineNotification";
NSString *JVBuddyUserStatusChangedNotification = @"JVBuddyUserStatusChangedNotification";
NSString *JVBuddyUserIdleTimeUpdatedNotification = @"JVBuddyUserIdleTimeUpdatedNotification";

NSString *JVBuddyActiveUserChangedNotification = @"JVBuddyActiveUserChangedNotification";

static JVBuddyName _mainPreferredName = JVBuddyFullName;

@implementation JVBuddy
+ (JVBuddyName) preferredName {
        return _mainPreferredName;
}

+ (void) setPreferredName:(JVBuddyName) preferred {
        _mainPreferredName = preferred;
}

#pragma mark -

- (id) init {
        if( ( self = [super init] ) ) {
                _rules = [[NSMutableArray allocWithZone:nil] initWithCapacity:5];
                _users = [[NSMutableSet allocWithZone:nil] initWithCapacity:5];
                _uniqueIdentifier = [[NSString locallyUniqueString] retain];

                [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector( _registerWithConnection: ) name:MVChatConnectionDidConnectNotification object:nil];
                [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector( _disconnected: ) name:MVChatConnectionDidDisconnectNotification object:nil];
        }

        return self;
}

- (id) initWithDictionaryRepresentation:(NSDictionary *) dictionary {
        if( ( self = [self init] ) ) {
                NSData *data = [dictionary objectForKey:@"picture"];
                if( [data isKindOfClass:[NSData class]] && [data length] )
                        _picture = [[NSKeyedUnarchiver unarchiveObjectWithData:data] retain];

                NSString *string = [dictionary objectForKey:@"firstName"];
                if( [string isKindOfClass:[NSString class]] )
                        _firstName = [string copyWithZone:nil];

                string = [dictionary objectForKey:@"lastName"];
                if( [string isKindOfClass:[NSString class]] )
                        _lastName = [string copyWithZone:nil];

                string = [dictionary objectForKey:@"primaryEmail"];
                if( [string isKindOfClass:[NSString class]] )
                        _primaryEmail = [string copyWithZone:nil];

                string = [dictionary objectForKey:@"givenNickname"];
                if( [string isKindOfClass:[NSString class]] )
                        _givenNickname = [string copyWithZone:nil];

                string = [dictionary objectForKey:@"speechVoice"];
                if( [string isKindOfClass:[NSString class]] )
                        _speechVoice = [string copyWithZone:nil];

                string = [dictionary objectForKey:@"uniqueIdentifier"];
                if( [string isKindOfClass:[NSString class]] ) {
                        [_uniqueIdentifier release];
                        _uniqueIdentifier = [string copyWithZone:nil];
                }

                if( ! [_uniqueIdentifier length] ) {
                        [_uniqueIdentifier release];
                        _uniqueIdentifier = [[NSString locallyUniqueString] retain];
                }

                string = [dictionary objectForKey:@"addressBookPersonRecord"];
                if( [string isKindOfClass:[NSString class]] )
                        _person = [[[ABAddressBook sharedAddressBook] recordForUniqueId:string] retain];

                NSEnumerator *enumerator = [[dictionary objectForKey:@"rules"] objectEnumerator];
                NSDictionary *ruleDictionary = nil;
                while( ( ruleDictionary = [enumerator nextObject] ) ) {
                        MVChatUserWatchRule *rule = [[MVChatUserWatchRule allocWithZone:nil] initWithDictionaryRepresentation:ruleDictionary];
                        if( rule ) [self addWatchRule:rule];
                        [rule release];
                }
        }

        return self;
}

- (void) dealloc {
        [self unregisterWithConnections];

        [[NSNotificationCenter defaultCenter] removeObserver:self];

        [_person release];
        [_rules release];
        [_users release];
        [_activeUser release];
        [_picture release];
        [_firstName release];
        [_lastName release];
        [_primaryEmail release];
        [_givenNickname release];
        [_speechVoice release];
        [_uniqueIdentifier release];

        _person = nil;
        _users = nil;
        _rules = nil;
        _activeUser = nil;
        _picture = nil;
        _firstName = nil;
        _lastName = nil;
        _primaryEmail = nil;
        _givenNickname = nil;
        _speechVoice = nil;
        _uniqueIdentifier = nil;

        [super dealloc];
}

#pragma mark -

- (NSDictionary *) dictionaryRepresentation {
        NSMutableDictionary *dictionary = [[NSMutableDictionary allocWithZone:nil] initWithCapacity:8];

        NSEnumerator *enumerator = [_rules objectEnumerator];
        NSMutableArray *rules = [[NSMutableArray allocWithZone:nil] initWithCapacity:[_rules count]];
        MVChatUserWatchRule *rule = nil;

        while( ( rule = [enumerator nextObject] ) ) {
                NSDictionary *dictRep = [rule dictionaryRepresentation];
                if( dictRep ) [rules addObject:dictRep];
        }

        [dictionary setObject:rules forKey:@"rules"];
        [rules release];

        if( _picture ) {
                NSData *imageData = [NSKeyedArchiver archivedDataWithRootObject:_picture];
                if( imageData ) [dictionary setObject:imageData forKey:@"picture"];
        }

        if( _firstName )
                [dictionary setObject:_firstName forKey:@"firstName"];

        if( _lastName )
                [dictionary setObject:_lastName forKey:@"lastName"];

        if( _primaryEmail )
                [dictionary setObject:_primaryEmail forKey:@"primaryEmail"];

        if( _givenNickname )
                [dictionary setObject:_givenNickname forKey:@"givenNickname"];

        if( _speechVoice )
                [dictionary setObject:_speechVoice forKey:@"speechVoice"];

        if( _uniqueIdentifier )
                [dictionary setObject:_uniqueIdentifier forKey:@"uniqueIdentifier"];

        if( _person && [_person uniqueId] )
                [dictionary setObject:[_person uniqueId] forKey:@"addressBookPersonRecord"];

        return [dictionary autorelease];
}

#pragma mark -

- (void) registerWithConnection:(MVChatConnection *) connection {
        NSEnumerator *enumerator = [_rules objectEnumerator];
        MVChatUserWatchRule *rule = nil;

        while( ( rule = [enumerator nextObject] ) ) {
                if( [[rule applicableServerDomains] count] ) {
                        NSEnumerator *domainEnumerator = [[rule applicableServerDomains] objectEnumerator];
                        NSString *domain = nil;

                        while( ( domain = [domainEnumerator nextObject] ) ) {
                                if( [[connection server] compare:domain options:( NSCaseInsensitiveSearch | NSLiteralSearch | NSBackwardsSearch | NSAnchoredSearch )] == NSOrderedSame ) {
                                        [connection addChatUserWatchRule:rule];
                                        break;
                                }
                        }
                } else [connection addChatUserWatchRule:rule];
        }
}

- (void) registerWithApplicableConnections {
        NSEnumerator *enumerator = [_rules objectEnumerator];
        MVChatUserWatchRule *rule = nil;

        while( ( rule = [enumerator nextObject] ) ) {
                if( [[rule applicableServerDomains] count] ) {
                        NSEnumerator *domainEnumerator = [[rule applicableServerDomains] objectEnumerator];
                        NSString *domain = nil;

                        while( ( domain = [domainEnumerator nextObject] ) ) {
                                NSEnumerator *connectionEnumerator = [[[MVConnectionsController defaultController] connectionsForServerAddress:domain] objectEnumerator];
                                MVChatConnection *connection = nil;

                                while( ( connection = [connectionEnumerator nextObject] ) )
                                        [connection addChatUserWatchRule:rule];
                        }
                } else {
                        NSEnumerator *connectionEnumerator = [[[MVConnectionsController defaultController] connections] objectEnumerator];
                        MVChatConnection *connection = nil;

                        while( ( connection = [connectionEnumerator nextObject] ) )
                                [connection addChatUserWatchRule:rule];
                }
        }
}

- (void) unregisterWithConnection:(MVChatConnection *) connection {
        NSEnumerator *enumerator = [_rules objectEnumerator];
        MVChatUserWatchRule *rule = nil;

        while( ( rule = [enumerator nextObject] ) )
                [connection removeChatUserWatchRule:rule];

        enumerator = [[[_users copy] autorelease] objectEnumerator];
        MVChatUser *user = nil;

        while( ( user = [enumerator nextObject] ) )
                if( [[user connection] isEqual:connection] )
                        [_users removeObject:user];

        if( [[[self activeUser] connection] isEqual:connection] )
                [self setActiveUser:[_users anyObject]];
}

- (void) unregisterWithConnections {
        NSEnumerator *enumerator = [_rules objectEnumerator];
        MVChatUserWatchRule *rule = nil;

        while( ( rule = [enumerator nextObject] ) ) {
                NSEnumerator *connectionEnumerator = [[[MVConnectionsController defaultController] connections] objectEnumerator];
                MVChatConnection *connection = nil;

                while( ( connection = [connectionEnumerator nextObject] ) )
                        [connection removeChatUserWatchRule:rule];
        }

        [_users removeAllObjects];
        [self setActiveUser:nil];
}

#pragma mark -

- (MVChatUser *) activeUser {
        return _activeUser;
}

- (void) setActiveUser:(MVChatUser *) user {
        if( [_activeUser isEqual:user] )
                return;

        id old = _activeUser;
        _activeUser = [user retain];
        [old release];

        [[NSNotificationCenter defaultCenter] postNotificationName:JVBuddyActiveUserChangedNotification object:self userInfo:nil];
}

#pragma mark -

- (MVChatUserStatus) status {
        return [[self activeUser] status];      
}

- (NSData *) awayStatusMessage {
        return [[self activeUser] awayStatusMessage];
}

#pragma mark -

- (BOOL) isOnline {
        return ( [_users count] > 0 );
}

- (NSDate *) dateConnected {
        return [[self activeUser] dateConnected];       
}

- (NSDate *) dateDisconnected {
        return [[self activeUser] dateDisconnected];    
}

#pragma mark -

- (NSTimeInterval) idleTime {
        return [[self activeUser] idleTime];    
}

#pragma mark -

- (NSString *) displayName {
        switch( [[self class] preferredName] ) {
                default:
                case JVBuddyFullName:
                        if( [[self compositeName] length] )
                                return [self compositeName];
                case JVBuddyGivenNickname:
                        if( [[self givenNickname] length] )
                                return [self givenNickname];
                case JVBuddyActiveNickname:
                        return [self nickname];
        }

        return [self nickname];
}

- (NSString *) nickname {
        return [[self activeUser] nickname];
}

#pragma mark -

- (NSSet *) users {
        return _users;
}

#pragma mark -

- (NSArray *) watchRules {
        return _rules;
}

- (void) addWatchRule:(MVChatUserWatchRule *) rule {
        if( [_rules containsObject:rule] ) return;
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector( _ruleMatched: ) name:MVChatUserWatchRuleMatchedNotification object:rule];
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector( _ruleUserRemoved: ) name:MVChatUserWatchRuleRemovedMatchedUserNotification object:rule];
        [_rules addObject:rule];
}

- (void) removeWatchRule:(MVChatUserWatchRule *) rule {
        if( ! [_rules containsObject:rule] ) return;
        [[NSNotificationCenter defaultCenter] removeObserver:self name:MVChatUserWatchRuleMatchedNotification object:rule];
        [[NSNotificationCenter defaultCenter] removeObserver:self name:MVChatUserWatchRuleRemovedMatchedUserNotification object:rule];
        [_rules removeObject:rule];
}

#pragma mark -

- (NSImage *) picture {
        if( _picture )
                return _picture;
        if( _person )
                return [[[NSImage alloc] initWithData:[_person imageData]] autorelease];
        return nil;
}

- (void) setPicture:(NSImage *) picture {
        id old = _picture;
        _picture = [picture copyWithZone:nil];
        [old release];
}

#pragma mark -

- (NSString *) compositeName {
        NSString *firstName = [self firstName];
        NSString *lastName = [self lastName];

        if( ! [firstName length] && [lastName length] )
                return lastName;
        if( [firstName length] && ! [lastName length] )
                return firstName;
        if( [firstName length] && [lastName length] )
                return [NSString stringWithFormat:@"%@ %@", firstName, lastName];

        firstName = [self givenNickname];
        if( [firstName length] )
                return firstName;

        return [[self activeUser] nickname];
}

- (NSString *) firstName {
        if( _firstName ) return _firstName;
        if( _person ) return [_person valueForProperty:kABFirstNameProperty];
        return nil;
}

- (NSString *) lastName {
        if( _lastName ) return _lastName;
        if( _person ) return [_person valueForProperty:kABLastNameProperty];
        return nil;
}

- (NSString *) primaryEmail {
        if( _primaryEmail ) return _primaryEmail;

        if( _person ) {
                ABMultiValue *value = [_person valueForProperty:kABEmailProperty];
                return [value valueAtIndex:[value indexForIdentifier:[value primaryIdentifier]]];
        }

        return nil;
}

- (NSString *) givenNickname {
        if( _givenNickname ) return _givenNickname;
        if( _person ) return [_person valueForProperty:kABNicknameProperty];
        return nil;
}

- (NSString *) speechVoice {
        return _speechVoice;
}

- (NSString *) uniqueIdentifier {
        return _uniqueIdentifier;
}

#pragma mark -

- (void) setFirstName:(NSString *) name {
        id old = _firstName;
        _firstName = [name copyWithZone:nil];
        [old release];
}

- (void) setLastName:(NSString *) name {
        id old = _lastName;
        _lastName = [name copyWithZone:nil];
        [old release];
}

- (void) setPrimaryEmail:(NSString *) email {
        id old = _primaryEmail;
        _primaryEmail = [email copyWithZone:nil];
        [old release];
}

- (void) setGivenNickname:(NSString *) name {
        id old = _givenNickname;
        _givenNickname = [name copyWithZone:nil];
        [old release];
}

- (void) setSpeechVoice:(NSString *) voice {
        id old = _speechVoice;
        _speechVoice = [voice copyWithZone:nil];
        [old release];
}

#pragma mark -

- (ABPerson *) addressBookPersonRecord {
        return _person;
}

- (void) setAddressBookPersonRecord:(ABPerson *) record {
        id old = _person;
        _person = [record retain];
        [old release];
}

- (void) editInAddressBook {
        if( ! _person ) return;
        NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"addressbook://%@?edit", [_person uniqueId]]];
        [[NSWorkspace sharedWorkspace] openURL:url];
}

- (void) viewInAddressBook {
        if( ! _person ) return;
        NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"addressbook://%@", [_person uniqueId]]];
        [[NSWorkspace sharedWorkspace] openURL:url];
}

#pragma mark -
#pragma mark Comparisons

- (NSComparisonResult) availabilityCompare:(JVBuddy *) buddy {
        unsigned int b1 = 0, b2 = 0;

        if( [self status] == MVChatUserAwayStatus ) b1 = 2;
        else if( [self status] == MVChatUserAvailableStatus ) {
                if( [self idleTime] >= 600. ) b1 = 1;
                else b1 = 0;
        } else b1 = 3;

        if( [buddy status] == MVChatUserAwayStatus ) b2 = 2;
        else if( [buddy status] == MVChatUserAvailableStatus ) {
                if( [buddy idleTime] >= 600. ) b2 = 1;
                else b2 = 0;
        } else b2 = 3;

        if( b1 > b2 ) return NSOrderedDescending;
        else if( b1 < b2 ) return NSOrderedAscending;
        return [self lastNameCompare:buddy];
}

- (NSComparisonResult) firstNameCompare:(JVBuddy *) buddy {
        NSComparisonResult ret = NSOrderedSame;
        NSString *name1 = [self firstName];
        NSString *name2 = [buddy firstName];

        if( ! [name1 length] ) name1 = [self lastName];
        if( ! [name2 length] ) name2 = [buddy lastName];

        if( ! [name1 length] && [name2 length] ) return NSOrderedAscending;
        else if( ! [name2 length] && [name1 length]  ) return NSOrderedDescending;

        ret = [name1 localizedCaseInsensitiveCompare:name2];
        if( ret != NSOrderedSame ) return ret;

        name1 = [self lastName];
        name2 = [buddy lastName];

        if( ! [name1 length] && [name2 length] ) return NSOrderedAscending;
        else if( ! [name2 length] && [name1 length]  ) return NSOrderedDescending;

        return [name1 localizedCaseInsensitiveCompare:name2];
}

- (NSComparisonResult) lastNameCompare:(JVBuddy *) buddy {
        NSComparisonResult ret = NSOrderedSame;
        NSString *name1 = [self lastName];
        NSString *name2 = [buddy lastName];

        if( ! [name1 length] ) name1 = [self firstName];
        if( ! [name2 length] ) name2 = [buddy firstName];

        if( ! [name1 length] && [name2 length] ) return NSOrderedAscending;
        else if( ! [name2 length] && [name1 length]  ) return NSOrderedDescending;

        ret = [name1 localizedCaseInsensitiveCompare:name2];
        if( ret != NSOrderedSame ) return ret;

        name1 = [self firstName];
        name2 = [buddy firstName];

        if( ! [name1 length] && [name2 length] ) return NSOrderedAscending;
        else if( ! [name2 length] && [name1 length]  ) return NSOrderedDescending;

        return [name1 localizedCaseInsensitiveCompare:name2];
}

- (NSComparisonResult) serverCompare:(JVBuddy *) buddy {
        NSString *server1 = [[self activeUser] serverAddress];
        NSString *server2 = [[buddy activeUser] serverAddress];
        NSComparisonResult ret = [server1 caseInsensitiveCompare:server2];
        return ( ret != NSOrderedSame ? ret : [self nicknameCompare:buddy] );
}

- (NSComparisonResult) nicknameCompare:(JVBuddy *) buddy {
        NSString *name1 = [[self activeUser] nickname];
        NSString *name2 = [[buddy activeUser] nickname];
        return [name1 caseInsensitiveCompare:name2];
}
@end

#pragma mark -

@implementation JVBuddy (JVBuddyPrivate)
- (void) _addUser:(MVChatUser *) user {
        if( [_users containsObject:user] )
                return;

        BOOL cameOnline = ! [_users count];
        [_users addObject:user];

        if( [self status] != MVChatUserAvailableStatus && [self status] != MVChatUserAwayStatus )
                [self setActiveUser:user];

        [[NSNotificationCenter defaultCenter] postNotificationName:JVBuddyUserCameOnlineNotification object:self userInfo:[NSDictionary dictionaryWithObject:user forKey:@"user"]];

        if( cameOnline )
                [[NSNotificationCenter defaultCenter] postNotificationName:JVBuddyCameOnlineNotification object:self userInfo:nil];
}

- (void) _removeUser:(MVChatUser *) user {
        if( ! [_users containsObject:user] )
                return;

        [_users removeObject:user];

        if( [[self activeUser] isEqualToChatUser:user] )
                [self setActiveUser:[_users anyObject]];

        [[NSNotificationCenter defaultCenter] postNotificationName:JVBuddyUserWentOfflineNotification object:self userInfo:[NSDictionary dictionaryWithObject:user forKey:@"user"]];

        if( ! [_users count] )
                [[NSNotificationCenter defaultCenter] postNotificationName:JVBuddyWentOfflineNotification object:self userInfo:nil];
}

- (void) _buddyIdleUpdate:(NSNotification *) notification {
        MVChatUser *user = [notification object];
        NSNotification *note = [NSNotification notificationWithName:JVBuddyUserIdleTimeUpdatedNotification object:self userInfo:[NSDictionary dictionaryWithObject:user forKey:@"user"]];
        [[NSNotificationQueue defaultQueue] enqueueNotification:note postingStyle:NSPostASAP coalesceMask:( NSNotificationCoalescingOnName | NSNotificationCoalescingOnSender ) forModes:nil];
}

- (void) _buddyStatusChanged:(NSNotification *) notification {
        MVChatUser *user = [notification object];

        switch( [user status] ) {
                case MVChatUserAvailableStatus:
                case MVChatUserAwayStatus:
                        [self _addUser:user];
                        break;
                case MVChatUserOfflineStatus:
                case MVChatUserDetachedStatus:
                        [self _removeUser:user];
                default: break;
        }

        [[NSNotificationCenter defaultCenter] postNotificationName:JVBuddyUserStatusChangedNotification object:self userInfo:[NSDictionary dictionaryWithObjectsAndKeys:user, @"user", nil]];
}

- (void) _registerWithConnection:(NSNotification *) notification {
        MVChatConnection *connection = [notification object];
        [self registerWithConnection:connection];
}

- (void) _disconnected:(NSNotification *) notification {
        MVChatConnection *connection = [notification object];
        NSEnumerator *enumerator = [[[_users copy] autorelease] objectEnumerator];
        MVChatUser *user = nil;

        while( ( user = [enumerator nextObject] ) )
                if( [[user connection] isEqual:connection] )
                        [self _removeUser:user];
}

- (void) _ruleMatched:(NSNotification *) notification {
        MVChatUser *user = [[notification userInfo] objectForKey:@"user"];

        if( [user status] == MVChatUserAvailableStatus || [user status] == MVChatUserAwayStatus )
                [self _addUser:user];

        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector( _buddyIdleUpdate: ) name:MVChatUserIdleTimeUpdatedNotification object:user];
        [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector( _buddyStatusChanged: ) name:MVChatUserStatusChangedNotification object:user];
}

- (void) _ruleUserRemoved:(NSNotification *) notification {
        MVChatUser *user = [[notification userInfo] objectForKey:@"user"];

        [[NSNotificationCenter defaultCenter] removeObserver:self name:MVChatUserIdleTimeUpdatedNotification object:user];
        [[NSNotificationCenter defaultCenter] removeObserver:self name:MVChatUserStatusChangedNotification object:user];

        [self _removeUser:user];
}
@end
/*
#pragma mark -

@implementation JVBuddy (JVBuddyScripting)
- (NSDictionary *) activeNicknameDictionary {
        MVChatConnection *connection = [[MVConnectionsController defaultController] connectionForServerAddress:[[self activeNickname] host]];
        return [NSDictionary dictionaryWithObjectsAndKeys:connection, @"connection", [[self activeNickname] user], @"nickname", nil];
}

- (NSArray *) nicknamesArray {
        NSMutableArray *ret = [NSMutableArray arrayWithCapacity:[_users count]];
        NSEnumerator *enumerator = [_users objectEnumerator];
        NSURL *nick = nil;

        while( ( nick = [enumerator nextObject] ) ) {
                MVChatConnection *connection = [[MVConnectionsController defaultController] connectionForServerAddress:[nick host]];
                if( ! connection ) continue;
                NSDictionary *info = [NSDictionary dictionaryWithObjectsAndKeys:connection, @"connection", [nick user], @"nickname", nil];
                [ret addObject:info];
        }

        return ret;
}

- (NSArray *) onlineNicknamesArray {
        NSMutableArray *ret = [NSMutableArray arrayWithCapacity:[_users count]];
        NSEnumerator *enumerator = [_users objectEnumerator];
        NSURL *nick = nil;

        while( ( nick = [enumerator nextObject] ) ) {
                MVChatConnection *connection = [[MVConnectionsController defaultController] connectionForServerAddress:[nick host]];
                if( ! connection ) continue;
                NSDictionary *info = [NSDictionary dictionaryWithObjectsAndKeys:connection, @"connection", [nick user], @"nickname", nil];
                [ret addObject:info];
        }

        return ret;
}

- (void) editInAddressBookScriptCommand:(NSScriptCommand *) command {
        [self editInAddressBook];
}

- (void) viewInAddressBookScriptCommand:(NSScriptCommand *) command {
        [self viewInAddressBook];
}
@end */