XMPPPerson.m

//
//  XMPPPerson.m
//  Jabber
//
//  Created by David Chisnall on Sun Apr 25 2004.
//  Copyright (c) 2004 __MyCompanyName__. All rights reserved.
//
#import "XMPPRootIdentity.h"
#import "XMPPPerson.h"
#import "XMPPDispatcher.h"
#import "XMPPRoster.h"
#import "CompareHack.h"
#import "XMPPConnection.h"
#import "XMPPServiceDiscovery.h"
#import "ABPerson+merging.h"

#ifndef GNUSTEP
#define kABJabberInstantProperty kABInstantMessageServiceJabber
#define kABMSNInstantProperty kABInstantMessageServiceMSN
#define kABAIMInstantProperty kABInstantMessageServiceAIM
#define kABICQInstantProperty kABInstantMessageServiceICQ
#define kABYahooInstantProperty kABInstantMessageServiceYahoo
#define kABMSNHomeLabel kABInstantMessageServiceMSN
#define kABAIMHomeLabel kABInstantMessageServiceAIM
#define kABJabberHomeLabel kABInstantMessageServiceJabber
#endif

static NSString * avatarCachePath = nil;

@implementation XMPPPerson
+ (void) initialize
{
	avatarCachePath = [NSString stringWithFormat:@"%@/%@/avatars/", 
						[NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) objectAtIndex:0],
						[[NSProcessInfo processInfo] processName]];
	NSArray * components = [avatarCachePath pathComponents];
	NSString * currentPath = [components objectAtIndex:0];
	NSFileManager * fm = [NSFileManager defaultManager];
	for(unsigned int i=0 ; i<[components count] ; i++)
	{
		currentPath = [currentPath stringByAppendingPathComponent:[components objectAtIndex:i]];
		if(![fm fileExistsAtPath:currentPath])
		{
            NSError *err;
			[fm createDirectoryAtPath:currentPath withIntermediateDirectories:YES attributes:nil error:&err];
		}
	}
	[super initialize];
}
+ (id) personWithIdentity:(XMPPIdentity*)_identity forRoster:(id)_roster
{
	return [[XMPPPerson alloc] initWithIdentity:_identity forRoster:(id)_roster];
}

- (void) calculateIdentityList
{
	[identityList removeAllObjects];
	FOREACH(identities, identity, XMPPIdentity*)
	{
		[identityList addObject:identity];
		if([identity isKindOfClass:[XMPPRootIdentity class]])
		{
			[identityList addObjectsFromArray:[(XMPPRootIdentity*)identity resources]];
		}
	}
	//[identityList sortUsingSelector:@selector(compareByPriority:)];
	[identityList sortUsingFunction:compareByPriority context:nil];
	identityCount = [identityList count];
}

- (id) init
{
	SUPERINIT
	identities = [[NSMutableDictionary alloc] init];
	identityList = [[NSMutableArray alloc] init];
	photoHashes = [[NSMutableDictionary alloc] init];
	return self;
}

- (id) initWithIdentity:(XMPPIdentity*)_identity forRoster:(id)_roster
{
	SELFINIT
	roster = _roster;
	[identities setValue:_identity forKey:[[_identity jid] jidString]];
	name = [_identity name];
	group = [_identity group];
	hash = [[NSString stringWithFormat:@"%@ some random wibble %@",name, group] hash];
	[_identity person:self];
	//Load the person's vCard
	NSUserDefaults * defaults = [NSUserDefaults standardUserDefaults];
	NSDictionary * vCards = [defaults dictionaryForKey:@"vCards"];
	NSString * vCardID = [vCards objectForKey:[NSString stringWithFormat:@"%@!%@", group, name]];
	if(vCardID != nil)
	{
		ABAddressBook * ab = [ABAddressBook sharedAddressBook];
		vCard = (ABPerson*)[ab recordForUniqueId:vCardID];
	}
	[self calculateIdentityList];
	return self;
}
- (void) requestvCard:(NSString*)jidString
{
	XMPPConnection * connection = (id)[roster connection];
	NSString * vCardRequestID = [connection nextMessageID];
	[connection XMPPSend:
	 [NSString stringWithFormat:@"<iq to='%@' type='get' id='%@'><vCard xmlns='vcard-temp'/></iq>"
	  , jidString, vCardRequestID]];
	[[roster dispatcher] addInfoQueryResultHandler:self forID:vCardRequestID];
}

- (void) addIdentity:(XMPPIdentity*)anIdentity
{
	NSString * jidString = [[anIdentity jid] jidString];
	[anIdentity person:self];
	[identities setValue:anIdentity forKey:jidString];
	[self calculateIdentityList];
	//Request the identity's vcard
	if(vCard == nil)
	{
		[self requestvCard:jidString];
	}
}

- (void) removeIdentity:(XMPPIdentity*)_identity
{
	[identities removeObjectForKey:[[_identity jid] jidString]];
	[self calculateIdentityList];
}
- (NSString*) group
{
	return group;
}

- (void) group:(NSString*)_group
{
	group = _group;
}

- (NSString*) name
{
	return name;
}

- (void) name:(NSString*)_name
{
	name = _name;
}

- (XMPPIdentity*) identityForJID:(JID*)jid
{
	XMPPIdentity * identity = [identities objectForKey:[jid jidString]];
	if([jid type] == resourceJID)
	{
		if (identity == nil)
		{
			return [identities objectForKey:[jid jidStringWithNoResource]];
		}
	}
	return identity;
}

- (NSUInteger) identities
{
	return identityCount;
}

- (XMPPIdentity*) defaultIdentity
{
	if(identityCount == 0)
	{
		return nil;
	}
	return [identityList objectAtIndex:0];
}

- (NSArray*) identityList
{
	return identityList;
}

- (id)copyWithZone:(NSZone *)zone
{
	return self;
}

//Hash value is computed when the object is created, and so will remain constant throughout the lifespan of the object.
- (NSUInteger) hash
{
	return hash;
}

- (void) handlePresence:(XMPPPresence*)aPresence
{
	NSString * from = [[aPresence jid] jidStringWithNoResource];
	
	XMPPIdentity * identity = [identities objectForKey:from];
	
	//vCard updates
	NSString * newPhotoHash = [[aPresence children] objectForKey:@"vCardUpdate"];
	if(newPhotoHash != nil && ![newPhotoHash isEqualToString:@""])
	{
		if(currentHash == nil)
		{
			currentHash = [[vCard imageData] sha1];
		}
		if(![photoHashes objectForKey:newPhotoHash])
		{
			NSData * data = [NSData dataWithContentsOfFile:[avatarCachePath stringByAppendingString:newPhotoHash]];
			if(data != nil)
			{
				currentHash = newPhotoHash;
				avatar = [[NSImage alloc] initWithData:data]; 
			}
			else
			{
				[self requestvCard:from];				
			}
		}
	}
	
	NSNotificationCenter * notifier = [NSNotificationCenter defaultCenter];
	
	//Set the presence for the identity
	XMPPPresence * oldPresence = [[self defaultIdentity] presence];//Retain this in case changing the presence would cause it to be released
	[identity setPresence:aPresence];
	
	[self calculateIdentityList];
	//Notify anyone who cares that a new presence has been received if it results in the presence of this person changing
	if([oldPresence show] != [aPresence show]
	   ||
	   ![[oldPresence status] isEqualToString:[aPresence status]]
	   )
	{
		//TODO: Make each Identity do this as well
		NSDictionary * userInfo = [NSDictionary dictionaryWithObjectsAndKeys:
			[NSNumber numberWithInt:[aPresence show]], @"NewPresence",
			[NSNumber numberWithInt:[oldPresence show]], @"OldPresence",
			[aPresence status], @"NewStatus",
			[oldPresence status], @"OldStatus",
			nil];
		[notifier postNotificationName:@"TRXMPPPresenceChanged" object:self userInfo:userInfo];			
	}
	[notifier postNotificationName:@"TRXMPPIdentityPresenceChanged" object:self userInfo:nil];
}

- (void) handleInfoQuery:(XMPPInfoQueryStanza*)anIq
{
	ABPerson * identityvCard = [[anIq children] objectForKey:@"vCard"];
	if(identityvCard != nil)
	{
		ABAddressBook * ab = [ABAddressBook sharedAddressBook];
		if(vCard != nil)
		{
			//Merge the vCard data
			NSArray * unmerged = [vCard mergePerson:identityvCard];
			if([unmerged count] > 0)
			{
				//TODO: Ask about which ones to merge
			}
		}
		else
		{
			vCard = identityvCard;
			if([vCard valueForProperty:kABNicknameProperty] == nil)
			{
				[vCard setValue:name forProperty:kABNicknameProperty];
			}
			//Parse bridged JIDs correctly (i.e. parse 123456@icq.example.com 
			//as an ICQ UIN, not a JID)
			id property = kABJabberInstantProperty;
			id label = kABJabberHomeLabel;
			JID * jid = [anIq jid];
			NSString * address = [jid jidStringWithNoResource];
			NSArray * serverIdentities = [[roster disco] identitiesForJID:[JID jidWithString:[jid domain]] node:nil];
			NSString * gatewayType = nil;
			FOREACH(serverIdentities, serverIdentity, NSDictionary*)
			{
				if([[serverIdentity objectForKey:@"category"] isEqualToString:@"gateway"])
				{
					gatewayType = [serverIdentity objectForKey:@"type"];
				}
			}
			if(gatewayType != nil)
			{
				if([gatewayType isEqualToString:@"msn"])
				{
					property = kABMSNInstantProperty;
					label = kABMSNHomeLabel;
					NSMutableString * msnAddress = [[jid node] mutableCopy];
					[msnAddress replaceOccurrencesOfString:@"%"
												withString:@"@"
												   options:0
													 range:NSMakeRange(0, [msnAddress length])];
					address = msnAddress;
				}
				else if([gatewayType isEqualToString:@"aim"])
				{
					property = kABAIMInstantProperty;
					label = kABAIMHomeLabel;
					address = [jid node];
				}
			}
			if(address != nil &&  [vCard valueForProperty:kABJabberInstantProperty] == nil)
			{
#ifdef GNUSTEP
				ABMutableMultiValue * vCardJID = 
					[(ABMutableMultiValue*)[ABMutableMultiValue alloc]
				   		initWithType:kABMultiStringProperty];
#else
				ABMutableMultiValue * vCardJID = [[ABMutableMultiValue alloc] init];
#endif
				[vCardJID addValue:address withLabel:label];
				[vCard setValue:vCardJID forProperty:property];
			}
			ABPerson * oldPerson = [vCard findExistingPerson];
			if(oldPerson != nil)
			{
				NSString * notes = [oldPerson valueForProperty:kABNoteProperty];
				if(notes == nil)
				{
					notes = @"";
				}
				notes = [notes stringByAppendingFormat:@"\nMerged properties from %@", [jid jidString]];
				[oldPerson setValue:notes forProperty:kABNoteProperty];
				[oldPerson mergePerson:vCard];
				vCard = oldPerson;
			}
			else
			{
				//Get the group that contains Jabber people
				ABGroup * jabberGroup = nil;
				NSArray * groups = [ab groups];
				FOREACH(groups, abgroup, ABRecord*)
				{
					if([[abgroup valueForProperty:kABGroupNameProperty] isEqualToString:@"Jabber People"])
					{
						jabberGroup = (ABGroup*)abgroup;
					}
				}
				if(jabberGroup == nil)
				{
					jabberGroup = [[ABGroup alloc] init];
					[jabberGroup setValue:@"Jabber People" forProperty:kABGroupNameProperty];
					[ab addRecord:jabberGroup];
				}
				[ab addRecord:vCard];
				[jabberGroup addMember:vCard];
			}
			[ab save];
			NSUserDefaults * defaults = [NSUserDefaults standardUserDefaults];
			NSDictionary * vCards = [defaults dictionaryForKey:@"vCards"];
			if(vCards == nil)
			{
				vCards = [NSDictionary dictionary];
			}			
			NSMutableDictionary * newvCards = [vCards mutableCopy];
			[newvCards setObject:[vCard uniqueId] forKey:[NSString stringWithFormat:@"%@!%@", group, name]];
			[defaults setObject:newvCards forKey:@"vCards"];
		}
		NSData * imageData = [identityvCard imageData];
		if(imageData != nil)
		{
			NSString * imageHash = [imageData sha1];
// FIXME: -writeToFile:options:error: has to be implemented in GNUstep base.
#ifdef GNUSTEP
			[imageData writeToFile:[avatarCachePath stringByAppendingString:imageHash]
			            atomically:YES];
#else
			[imageData writeToFile:[avatarCachePath stringByAppendingString:imageHash]
						   options:0
							 error:NULL];
#endif
			if(![imageHash isEqualToString:currentHash])
			{
				[photoHashes setObject:imageData forKey:imageHash];
				avatar = nil;
				currentHash = imageHash;
			}
		}		
	}
}

- (NSComparisonResult) compare:(XMPPPerson*)otherPerson
{
	XMPPPresence * myDefaultPresence = [[self defaultIdentity] presence];
	unsigned char myPresence = myDefaultPresence == nil ? PRESENCE_UNKNOWN : [myDefaultPresence show];
	unsigned char otherPresence = [[[otherPerson defaultIdentity] presence] show];
	NSComparisonResult result;
	if (myPresence < otherPresence)
	{
		result = NSOrderedAscending;
	}
	else if (myPresence > otherPresence)
	{
		result = NSOrderedDescending;
	}
	else //if (myPresence == otherPresence)
	{
		result = [name caseInsensitiveCompare:[otherPerson name]];
		//result = NSOrderedSame;
	}
	//ETLog(@"Comparing %@(%d) to %@(%d) gives %d", name, (int)myPresence, [otherPerson name], (int)otherPresence, result);

	return result;
}

- (NSImage*) avatar
{
	if(avatar == nil)
	{
		NSData * avatarData = [photoHashes objectForKey:currentHash];
		if(avatarData == nil)
		{
			avatarData = [vCard imageData];
			if(avatarData != nil)
			{
				currentHash = [avatarData sha1];
				[photoHashes setObject:avatarData forKey:currentHash];
			}
		}
		if(avatarData != nil)
		{
			avatar = [[NSImage alloc] initWithData:avatarData];
		}
	}
	return avatar;
}

@end