/*

        File: IMStatusPlugIn.m

    Abstract: IMStatusPlugin class.

     Version: 1.0

    Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple

    Inc. ("Apple") in consideration of your agreement to the following

    terms, and your use, installation, modification or redistribution of

    this Apple software constitutes acceptance of these terms.  If you do

    not agree with these terms, please do not use, install, modify or

    redistribute this Apple software.

    In consideration of your agreement to abide by the following terms, and

    subject to these terms, Apple grants you a personal, non-exclusive

    license, under Apple's copyrights in this original Apple software (the

    "Apple Software"), to use, reproduce, modify and redistribute the Apple

    Software, with or without modifications, in source and/or binary forms;

    provided that if you redistribute the Apple Software in its entirety and

    without modifications, you must retain this notice and the following

    text and disclaimers in all such redistributions of the Apple Software.

    Neither the name, trademarks, service marks or logos of Apple Inc. may

    be used to endorse or promote products derived from the Apple Software

    without specific prior written permission from Apple.  Except as

    expressly stated in this notice, no other rights or licenses, express or

    implied, are granted by Apple herein, including but not limited to any

    patent rights that may be infringed by your derivative works or by other

    works in which the Apple Software may be incorporated.

    The Apple Software is provided by Apple on an "AS IS" basis.  APPLE

    MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION

    THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS

    FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND

    OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

    IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL

    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

    INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,

    MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED

    AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),

    STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE

    POSSIBILITY OF SUCH DAMAGE.

    Copyright (C) 2009 Apple Inc. All Rights Reserved.

*/

#import <InstantMessage/IMService.h>

/* It's highly recommended to use CGL macros instead of changing the current context for plug-ins that perform OpenGL rendering */

#import <OpenGL/CGLMacro.h>

#import "IMStatusPlugIn.h"

#define kQCPlugIn_Name              @"Instant Messaging Status"

#define kQCPlugIn_Description       @"This patches returns information about the logged in user and their buddies on a given instant messaging service."

static NSString*                    _statusStrings[] = {@"Unknown", @"Offline", @"Idle", @"Away", @"Available", @"No Status"};

@interface IMStatusPlugIn (Internal)

- (void) _updateService;

@end

@implementation IMStatusPlugIn

/* We need to declare the input / output properties as dynamic as Quartz Composer will handle their implementation */

@dynamic outputUser, outputBuddies;

+ (NSDictionary*) attributes

{

    /* Return the attributes of this plug-in */

    return [NSDictionary dictionaryWithObjectsAndKeys:kQCPlugIn_Name, QCPlugInAttributeNameKey, kQCPlugIn_Description, QCPlugInAttributeDescriptionKey, nil];

}

+ (NSDictionary*) attributesForPropertyPortWithKey:(NSString*)key

{

    /* Return the attributes for the plug-in property ports */

    if([key isEqualToString:@"outputUser"])

    return [NSDictionary dictionaryWithObject:@"User Status" forKey:QCPortAttributeNameKey];

    if([key isEqualToString:@"outputBuddies"])

    return [NSDictionary dictionaryWithObject:@"Buddies Status" forKey:QCPortAttributeNameKey];

    return nil;

}

+ (QCPlugInExecutionMode) executionMode

{

    /* This plug-in is a provider (it provides data from an external source) */

    return kQCPlugInExecutionModeProvider;

}

+ (QCPlugInTimeMode) timeMode

{

    /* This plug-in does not depend on the time (time parameter is completely ignored in the -execute:atTime:withArguments: method) but we need idling */

    return kQCPlugInTimeModeIdle;

}

- (id) init

{

    if(self = [super init]) {

        /* Set a default value for our internal setting */

        _serviceName = @"AIM";

        pthread_mutex_init(&_statusMutex, NULL);

    }

    return self;

}

- (void) dealloc

{

    [_serviceName release];

    pthread_mutex_destroy(&_statusMutex);

    [super dealloc];

}

+ (NSArray*) plugInKeys

{

    /* Return the list of KVC keys corresponding to our internal settings */

    return [NSArray arrayWithObject:@"serviceName"];

}

- (void) setServiceName:(NSString*)name

{

    [_serviceName release];

    _serviceName = [name copy];

    [self _updateService];

}

- (NSString*) serviceName

{

    return _serviceName;

}

- (QCPlugInViewController*) createViewController

{

    /* Create a QCPlugInViewController to handle the user-interface to edit the our internal settings */

    return [[QCPlugInViewController alloc] initWithPlugIn:self viewNibName:@"IMStatusSettings"];

}

/* Used by NSArrayController in nib file */

- (NSArray*) allServiceNames

{

    NSMutableArray*         array = [NSMutableArray array];

    NSArray*                services = [IMService allServices];

    NSUInteger              i;

    for(i = 0; i < [services count]; ++i)

    [array addObject:[(IMService*)[services objectAtIndex:i] name]];

    return array;

}

@end

@implementation IMStatusPlugIn (Execution)

- (void) _userUpdated:(NSNotification*)notification

{

    IMPersonStatus          status = [IMService myStatus];

    /* Update the user status */

    pthread_mutex_lock(&_statusMutex);

    [_userStatus setObject:[NSNumber numberWithUnsignedInteger:status] forKey:@"value"];

    [_userStatus setObject:_statusStrings[status] forKey:@"title"];

    [_userStatus setObject:[NSImage imageNamed:[IMService imageNameForStatus:status]] forKey:@"image"];

    _userStatusUpdated = YES;

    pthread_mutex_unlock(&_statusMutex);

}

- (void) _buddiesUpdated:(NSNotification*)notification

{

    NSString*               screenName = [[notification userInfo] objectForKey:IMPersonScreenNameKey];

    NSDictionary*           info = [_service infoForScreenName:screenName];

    IMPersonStatus          status = [[info objectForKey:IMPersonStatusKey] unsignedIntegerValue];

    NSMutableDictionary*    dictionary;

    /* Build the buddy status */

    if(status != IMPersonStatusUnknown) {

        dictionary = [NSMutableDictionary dictionary];

        [dictionary setValue:screenName forKey:@"screenName"];

        [dictionary setObject:[NSNumber numberWithUnsignedInteger:status] forKey:@"statusValue"];

        [dictionary setObject:_statusStrings[status] forKey:@"statusTitle"];

        [dictionary setObject:[NSImage imageNamed:[IMService imageNameForStatus:status]] forKey:@"statusImage"];

        [dictionary setValue:[info objectForKey:IMPersonStatusMessageKey] forKey:@"statusMessage"];

        [dictionary setValue:[info objectForKey:IMPersonFirstNameKey] forKey:@"firstName"];

        [dictionary setValue:[info objectForKey:IMPersonLastNameKey] forKey:@"lastName"];

        [dictionary setValue:[info objectForKey:IMPersonPictureDataKey] forKey:@"pictureData"];

    }

    else

    dictionary = nil;

    /* Update the buddy status */

    pthread_mutex_lock(&_statusMutex);

    [_buddiesStatus setValue:dictionary forKey:screenName];

    _buddiesStatusUpdated = YES;

    pthread_mutex_unlock(&_statusMutex);

}

- (void) _updateService

{

    /* Terminate current connection to IM service */

    if(_service) {

        [[IMService notificationCenter] removeObserver:self name:IMMyStatusChangedNotification object:nil];

        [[IMService notificationCenter] removeObserver:self name:IMStatusImagesChangedAppearanceNotification object:nil];

        [[IMService notificationCenter] removeObserver:self name:IMPersonStatusChangedNotification object:_service];

        [[IMService notificationCenter] removeObserver:self name:IMPersonInfoChangedNotification object:_service];

        [_service release];

    }

    /* Open new connection to IM service */

    if(_executing) {

        _service = (_serviceName ? [[IMService serviceWithName:_serviceName] retain] : nil);

        [[IMService notificationCenter] addObserver:self selector:@selector(_userUpdated:) name:IMMyStatusChangedNotification object:nil];

        [[IMService notificationCenter] addObserver:self selector:@selector(_userUpdated:) name:IMStatusImagesChangedAppearanceNotification object:nil];

        [[IMService notificationCenter] addObserver:self selector:@selector(_buddiesUpdated:) name:IMPersonStatusChangedNotification object:_service];

        [[IMService notificationCenter] addObserver:self selector:@selector(_buddiesUpdated:) name:IMPersonInfoChangedNotification object:_service];

        [_userStatus removeAllObjects];

        _userStatusUpdated = NO;

        [_buddiesStatus removeAllObjects];

        _buddiesStatusUpdated = YES;

    }

    else

    _service = nil;

}

- (BOOL) startExecution:(id<QCPlugInContext>)context

{

    /* Setup */

    _userStatus = [NSMutableDictionary new];

    _buddiesStatus = [NSMutableDictionary new];

    _executing = YES;

    [self _updateService];

    return YES;

}

- (BOOL) execute:(id<QCPlugInContext>)context atTime:(NSTimeInterval)time withArguments:(NSDictionary*)arguments

{

    /* Update outputs with latest user & buddy status if necessary */

    pthread_mutex_lock(&_statusMutex);

    if(_userStatusUpdated) {

        self.outputUser = [NSDictionary dictionaryWithDictionary:_userStatus];

        _userStatusUpdated = NO;

    }

    if(_buddiesStatusUpdated) {

        self.outputBuddies = [NSDictionary dictionaryWithDictionary:_buddiesStatus];

        _buddiesStatusUpdated = NO;

    }

    pthread_mutex_unlock(&_statusMutex);

    return YES;

}

- (void) stopExecution:(id<QCPlugInContext>)context

{

    /* Clean up*/

    _executing = NO;

    [self _updateService];

    [_userStatus release];

    [_buddiesStatus release];

}

@end