//

//  GrowlApplicationController.m

//  Growl

//

//  Created by Karl Adam on Thu Apr 22 2004.

//  Renamed from GrowlController by Mac-arena the Bored Zo on 2005-06-28.

//  Copyright 2004-2006 The Growl Project. All rights reserved.

//

// This file is under the BSD License, refer to License.txt for details

#import "GrowlApplicationController.h"

#import "GrowlPreferencesController.h"

#import "GrowlApplicationTicket.h"

#import "GrowlApplicationNotification.h"

#import "GrowlTicketController.h"

#import "GrowlNotificationTicket.h"

#import "GrowlPathway.h"

#import "GrowlPathwayController.h"

#import "GrowlPropertyListFilePathway.h"

#import "GrowlPathUtilities.h"

#import "NSStringAdditions.h"

#import "GrowlDisplayPlugin.h"

#import "GrowlPluginController.h"

#import "GrowlIdleStatusController.h"

#import "GrowlDefines.h"

#import "GrowlVersionUtilities.h"

#import "SVNRevision.h"

#import "GrowlLog.h"

#import "GrowlNotificationCenter.h"

#import "MD5Authenticator.h"

#include "CFGrowlAdditions.h"

#include "CFURLAdditions.h"

#include "CFDictionaryAdditions.h"

#include "CFMutableDictionaryAdditions.h"

#include "cdsa.h"

#include <SystemConfiguration/SystemConfiguration.h>

#include <sys/errno.h>

#include <string.h>

#include <sys/socket.h>

#include <sys/fcntl.h>

#include <netinet/in.h>

// check every 24 hours

#define UPDATE_CHECK_INTERVAL	24.0*3600.0

//Notifications posted by GrowlApplicationController

#define UPDATE_AVAILABLE_NOTIFICATION	@"Growl update available"

#define USER_WENT_IDLE_NOTIFICATION		@"User went idle"

#define USER_RETURNED_NOTIFICATION		@"User returned"

static OSStatus soundCompletionCallbackProc(SystemSoundActionID actionID, void *refcon);

extern CFRunLoopRef CFRunLoopGetMain(void);

@interface GrowlApplicationController (PRIVATE)

- (void) notificationClicked:(NSNotification *)notification;

- (void) notificationTimedOut:(NSNotification *)notification;

@end

/*applications that go full-screen (games in particular) are expected to capture

 *	whatever display(s) they're using.

 *we [will] use this to notice, and turn on auto-sticky or something (perhaps

 *	to be decided by the user), when this happens.

 */

#if 0

static BOOL isAnyDisplayCaptured(void) {

	BOOL result = NO;

	CGDisplayCount numDisplays;

	CGDisplayErr err = CGGetActiveDisplayList(/*maxDisplays*/ 0U, /*activeDisplays*/ NULL, &numDisplays);

	if (err != noErr)

		[[GrowlLog sharedController] writeToLog:@"Checking for captured displays: Could not count displays: %li", (long)err];

	else {

		CGDirectDisplayID *displays = malloc(numDisplays * sizeof(CGDirectDisplayID));

		CGGetActiveDisplayList(numDisplays, displays, /*numDisplays*/ NULL);

		if (!displays)

			[[GrowlLog sharedController] writeToLog:@"Checking for captured displays: Could not allocate list of displays: %s", strerror(errno)];

		else {

			for (CGDisplayCount i = 0U; i < numDisplays; ++i) {

				if (CGDisplayIsCaptured(displays[i])) {

					result = YES;

					break;

				}

			}

			free(displays);

		}

	}

	return result;

}

#endif

//static struct Version version = { 0U, 8U, 0U, releaseType_svn, 0U, };

#warning Having to update this struct manually is ugly. Use the info.plist.

#warning And once code is in to automagically update this from Info.plist, the documentation in GrowlVersionUtilities.h should also be updated.

static struct Version version = { 1U, 1U, 5U, releaseType_svn, 0U, };

//XXX - update these constants whenever the version changes

static void checkVersion(CFRunLoopTimerRef timer, void *context) {

#pragma unused(timer)

	GrowlPreferencesController *preferences = [GrowlPreferencesController sharedController];

	if (![preferences isBackgroundUpdateCheckEnabled])

		return;

	GrowlApplicationController *appController = (GrowlApplicationController *)context;

	NSURL *versionCheckURL = [appController versionCheckURL];

	NSDictionary *productVersionDict = [[NSDictionary alloc] initWithContentsOfURL:versionCheckURL];

	NSString *currVersionNumber = [GrowlApplicationController growlVersion];

	NSString *latestVersionNumber = [productVersionDict objectForKey:@"Growl"];

	NSString *downloadURLString = [productVersionDict objectForKey:@"GrowlDownloadURL"];

	/* do nothing and be quiet if there is no active connection, if the

	 *	version dictionary could not be downloaded, or if the version dictionary

	 *	is missing either of these keys.

	 */

	if (downloadURLString && latestVersionNumber) {

		[preferences setObject:[NSDate date] forKey:LastUpdateCheckKey];

		if (compareVersionStringsTranslating1_0To0_5(latestVersionNumber, currVersionNumber) > 0) {

			CFStringRef title = CFCopyLocalizedString(CFSTR("Update Available"), /*comment*/ NULL);

			CFStringRef description = CFCopyLocalizedString(CFSTR("A newer version of Growl is available online. Click here to download it now."), /*comment*/ NULL);

			[GrowlApplicationBridge notifyWithTitle:(NSString *)title

				                        description:(NSString *)description

				                   notificationName:UPDATE_AVAILABLE_NOTIFICATION

			                               iconData:[appController applicationIconDataForGrowl]

			                               priority:1

			                               isSticky:YES

			                           clickContext:downloadURLString

										 identifier:UPDATE_AVAILABLE_NOTIFICATION];

			CFRelease(title);

			CFRelease(description);

		}

	}

	[productVersionDict release];

}

@implementation GrowlApplicationController

+ (GrowlApplicationController *) sharedController {

	return [self sharedInstance];

}

- (id) initSingleton {

	if ((self = [super initSingleton])) {

		CSSM_RETURN crtn = cdsaInit();

		if (crtn) {

			NSLog(@"ERROR: Could not initialize CDSA.");

			cssmPerror("cdsaInit", crtn);

			[self release];

			return nil;

		}

		// initialize GrowlPreferencesController before observing GrowlPreferencesChanged

		GrowlPreferencesController *preferences = [GrowlPreferencesController sharedController];

		NSDistributedNotificationCenter *NSDNC = [NSDistributedNotificationCenter defaultCenter];

		[NSDNC addObserver:self

				  selector:@selector(preferencesChanged:)

					  name:GrowlPreferencesChanged

					object:nil];

		[NSDNC addObserver:self

				  selector:@selector(showPreview:)

					  name:GrowlPreview

					object:nil];

		[NSDNC addObserver:self

				  selector:@selector(shutdown:)

					  name:GROWL_SHUTDOWN

					object:nil];

		[NSDNC addObserver:self

				  selector:@selector(replyToPing:)

					  name:GROWL_PING

					object:nil];

		NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];

		[nc addObserver:self

			   selector:@selector(notificationClicked:)

				   name:GROWL_NOTIFICATION_CLICKED

				 object:nil];

		[nc addObserver:self

			   selector:@selector(notificationTimedOut:)

				   name:GROWL_NOTIFICATION_TIMED_OUT

				 object:nil];

		ticketController = [GrowlTicketController sharedController];

		[GrowlApplicationBridge setGrowlDelegate:self];

		[self versionDictionary];

		NSString *file = [[NSBundle mainBundle] pathForResource:@"GrowlDefaults" ofType:@"plist"];

		NSURL *fileURL = [NSURL fileURLWithPath:file];

		NSDictionary *defaultDefaults = (NSDictionary *)createPropertyListFromURL((NSURL *)fileURL, kCFPropertyListImmutable, NULL, NULL);

		if (defaultDefaults) {

			[preferences registerDefaults:defaultDefaults];

			[defaultDefaults release];

		}

		if ([GrowlPathUtilities runningHelperAppBundle] != [NSBundle mainBundle]) {

			/*We are not the real GHA.

			 *We are another GHA that a pre-1.1.3 GAB has invoked to register an application by a plist file.

			 *This means that we should not start up the pathway controller; we should, instead, start up the plist-file pathway directly, and wait up to one second for -application:openFile: messages, and forward them to the plist-file pathway (as appropriate), and quit one second after the last one.

			 */

			NSLog(@"%@", @"It appears that at least one other instance of Growl is running. This one will quit.");

			quitAfterOpen = YES;

		} else {

			//This class doesn't exist in the prefpane.

			Class pathwayControllerClass = NSClassFromString(@"GrowlPathwayController");

			if (pathwayControllerClass)

				[pathwayControllerClass sharedController];

		}

		[self preferencesChanged:nil];

		[[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self

															   selector:@selector(applicationLaunched:)

																   name:NSWorkspaceDidLaunchApplicationNotification

																 object:nil];

		growlIcon = [[NSImage imageNamed:@"NSApplicationIcon"] retain];

		GrowlIdleStatusController_init();

		[nc addObserver:self

			   selector:@selector(idleStatus:)

				   name:@"GrowlIdleStatus"

				 object:nil];

		NSDate *lastCheck = [preferences objectForKey:LastUpdateCheckKey];

		NSDate *now = [NSDate date];

		if (!lastCheck || [now timeIntervalSinceDate:lastCheck] > UPDATE_CHECK_INTERVAL) {

			checkVersion(NULL, self);

			lastCheck = now;

		}

		CFRunLoopTimerContext context = {0, self, NULL, NULL, NULL};

		updateTimer = CFRunLoopTimerCreate(kCFAllocatorDefault, [[lastCheck addTimeInterval:UPDATE_CHECK_INTERVAL] timeIntervalSinceReferenceDate], UPDATE_CHECK_INTERVAL, 0, 0, checkVersion, &context);

		CFRunLoopAddTimer(CFRunLoopGetMain(), updateTimer, kCFRunLoopCommonModes);

		// create and register GrowlNotificationCenter

		growlNotificationCenter = [[GrowlNotificationCenter alloc] init];

		growlNotificationCenterConnection = [[NSConnection alloc] initWithReceivePort:[NSPort port] sendPort:nil];

		//[growlNotificationCenterConnection enableMultipleThreads];

		[growlNotificationCenterConnection setRootObject:growlNotificationCenter];

		if (![growlNotificationCenterConnection registerName:@"GrowlNotificationCenter"])

			NSLog(@"WARNING: could not register GrowlNotificationCenter for interprocess access");

		soundCompletionCallback = NewSystemSoundCompletionUPP(soundCompletionCallbackProc);

	}

	return self;

}

- (void) idleStatus:(NSNotification *)notification {

	if ([[notification object] isEqualToString:@"Idle"]) {

		GrowlPreferencesController *preferences = [GrowlPreferencesController sharedController];

		int idleThreshold;

		NSNumber *value = [preferences objectForKey:@"IdleThreshold"];

		NSString *description;

		idleThreshold = (value ? [value intValue] : MACHINE_IDLE_THRESHOLD);

		description = [NSString stringWithFormat:NSLocalizedString(@"No activity for more than %d seconds.", nil), idleThreshold];

		if ([preferences stickyWhenAway])

			description = [description stringByAppendingString:NSLocalizedString(@" New notifications will be sticky.", nil)];

		[GrowlApplicationBridge notifyWithTitle:NSLocalizedString(@"User went idle", nil)

									description:description

							   notificationName:USER_WENT_IDLE_NOTIFICATION

									   iconData:growlIconData

									   priority:-1

									   isSticky:NO

								   clickContext:nil

									 identifier:nil];

	} else {

		[GrowlApplicationBridge notifyWithTitle:NSLocalizedString(@"User returned", nil)

									description:NSLocalizedString(@"User activity detected. New notifications will not be sticky by default.", nil)

							   notificationName:USER_RETURNED_NOTIFICATION

									   iconData:growlIconData

									   priority:-1

									   isSticky:NO

								   clickContext:nil

									 identifier:nil];

	}

}

- (void) destroy {

	//free your world

	[mainThread release]; mainThread = nil;

	Class pathwayControllerClass = NSClassFromString(@"GrowlPathwayController");

	if (pathwayControllerClass)

		[(id)[pathwayControllerClass sharedController] setServerEnabled:NO];

	[destinations     release]; destinations = nil;

	[growlIcon        release]; growlIcon = nil;

	[defaultDisplayPlugin release]; defaultDisplayPlugin = nil;

	[versionCheckURL release];

	GrowlIdleStatusController_dealloc();

	CFRunLoopTimerInvalidate(updateTimer);

	CFRelease(updateTimer);

	[[NSNotificationCenter defaultCenter] removeObserver:self name:nil object:nil];

	[growlNotificationCenterConnection invalidate];

	[growlNotificationCenterConnection release]; growlNotificationCenterConnection = nil;

	[growlNotificationCenter           release]; growlNotificationCenter = nil;

	cdsaShutdown();

	DisposeSystemSoundCompletionUPP(soundCompletionCallback);

	[super destroy];

}

#pragma mark Guts

- (void) showPreview:(NSNotification *) note {

	NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

	NSString *displayName = [note object];

	GrowlDisplayPlugin *displayPlugin = (GrowlDisplayPlugin *)[[GrowlPluginController sharedController] displayPluginInstanceWithName:displayName author:nil version:nil type:nil];

	NSString *desc = [[NSString alloc] initWithFormat:NSLocalizedString(@"This is a preview of the %@ display", "Preview message shown when clicking Preview in the system preferences pane. %@ becomes the name of the display style being used."), displayName];

	NSNumber *priority = [[NSNumber alloc] initWithInt:0];

	NSNumber *sticky = [[NSNumber alloc] initWithBool:NO];

	NSDictionary *info = [[NSDictionary alloc] initWithObjectsAndKeys:

		@"Growl",   GROWL_APP_NAME,

		@"Preview", GROWL_NOTIFICATION_NAME,

		NSLocalizedString(@"Preview", "Title of the Preview notification shown to demonstrate Growl displays"), GROWL_NOTIFICATION_TITLE,

		desc,       GROWL_NOTIFICATION_DESCRIPTION,

		priority,   GROWL_NOTIFICATION_PRIORITY,

		sticky,     GROWL_NOTIFICATION_STICKY,

		growlIcon,  GROWL_NOTIFICATION_ICON,

		nil];

	[desc     release];

	[priority release];

	[sticky   release];

	GrowlApplicationNotification *notification = [[GrowlApplicationNotification alloc] initWithDictionary:info];

	[info release];

	[displayPlugin displayNotification:notification];

	[notification release];

	[pool release];

}

/*!

 * @brief Get address data for a Growl server

 *

 * @param name The name of the server

 * @result An NSData which contains a (struct sockaddr *)'s data. This may actually be a sockaddr_in or a sockaddr_in6.

 */

- (NSData *)addressDataForGrowlServerWithName:(NSString *)name

{

	NSNetService *service = [[[NSNetService alloc] initWithDomain:@"local." type:@"_growl._tcp." name:name] autorelease];

    if (!service) {

		/* No such service exists. The computer is probably offline. */

        return nil;

    }

	/* Work for 8 seconds to resolve the net service to an IP and port. We should be running

	 * on a thread, so blocking is fine.

	 */

    [service scheduleInRunLoop:[NSRunLoop currentRunLoop] forMode:@"PrivateGrowlMode"];

    [service resolveWithTimeout:8.0];

    CFAbsoluteTime deadline = CFAbsoluteTimeGetCurrent() + 8.0;

    CFTimeInterval remaining;

    while ((remaining = (deadline - CFAbsoluteTimeGetCurrent())) > 0 && [[service addresses] count] == 0) {

        CFRunLoopRunInMode((CFStringRef)@"PrivateGrowlMode", remaining, true);

    }

    [service stop];

    NSArray *addresses = [service addresses];

    if (![addresses count]) {

		/* Lookup failed */

        return nil;

    }

	return [addresses objectAtIndex:0];

}	

- (void) forwardDictionary:(NSDictionary *)dict withSelector:(SEL)forwardMethod {

	NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

	NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];

	NSNumber *requestTimeout = [defaults objectForKey:@"ForwardingRequestTimeout"];

	NSNumber *replyTimeout = [defaults objectForKey:@"ForwardingReplyTimeout"];

	NSEnumerator *enumerator = [destinations objectEnumerator];

	NSDictionary *entry;

	while ((entry = [enumerator nextObject])) {

		if (getBooleanForKey(entry, @"use") && getBooleanForKey(entry, @"active")) {

			/* Note: This assumes that all forwarding destinations are within the local network.

			 * When domain names and IPs can be used, this needs to change.

			 */

			NSData *destAddress = [self addressDataForGrowlServerWithName:[entry objectForKey:@"computer"]];

			if (!destAddress) {

				/* No destination address. Nothing to see here; move along. */

#ifdef DEBUG

				NSLog(@"Could not obtain destination address for %@", [entry objectForKey:@"computer"]);

#endif

				continue;

			}

			NSString *password = [entry objectForKey:@"password"];

			/* Send via DO if possible */

			NSSocketPort *serverPort = [[NSSocketPort alloc]

				initRemoteWithProtocolFamily:AF_INET

								  socketType:SOCK_STREAM

									protocol:IPPROTO_TCP

									 address:destAddress];

			NSConnection *connection = [[NSConnection alloc] initWithReceivePort:nil

																		sendPort:serverPort];

			MD5Authenticator *auth = [[MD5Authenticator alloc] initWithPassword:password];

			[connection setDelegate:auth];

			if (requestTimeout && [requestTimeout respondsToSelector:@selector(floatValue)])

				[connection setRequestTimeout:[requestTimeout floatValue]];

			if (replyTimeout && [replyTimeout respondsToSelector:@selector(floatValue)])

				[connection setReplyTimeout:[replyTimeout floatValue]];

			@try {

				NSDistantObject *theProxy = [connection rootProxy];

				[theProxy setProtocolForProxy:@protocol(GrowlNotificationProtocol)];

				NSProxy <GrowlNotificationProtocol> *growlProxy = (NSProxy <GrowlNotificationProtocol> *)theProxy;

				[growlProxy performSelector:forwardMethod withObject:dict];

			} @catch (NSException *e) {

				NSString *addressString = createStringWithAddressData(destAddress);

				NSString *hostName = createHostNameForAddressData(destAddress);

				if ([[e name] isEqualToString:NSFailedAuthenticationException]) {

					NSLog(@"Authentication failed while forwarding to %@ (%@)",

						  addressString, hostName);

				} else {

					NSLog(@"Warning: Exception %@ while forwarding Growl registration or notification (%@) to %@ (%@). Is that system on and connected?",

						  e, NSStringFromSelector(forwardMethod), addressString, hostName);

				}

				[addressString release];

				[hostName      release];

			} @finally {

				[connection invalidate];

				[serverPort invalidate];

				[serverPort release];

				[connection release];

				[auth release];

			}

		}

	}

	[pool release];

}

- (void) forwardNotification:(NSDictionary *)dict {

	[self forwardDictionary:dict withSelector:@selector(postNotificationWithDictionary:)];

}

- (void) forwardRegistration:(NSDictionary *)dict {

	[self forwardDictionary:dict withSelector:@selector(registerApplicationWithDictionary:)];

}

#pragma mark Retrieving sounds

- (OSStatus) getFSRef:(out FSRef *)outRef forSoundNamed:(NSString *)soundName {

	BOOL foundIt = NO;

	NSArray *soundTypes = [NSSound soundUnfilteredFileTypes];

	//Throw away all the HFS types, leaving only filename extensions.

	NSPredicate *noHFSTypesPredicate = [NSPredicate predicateWithFormat:@"NOT (self BEGINSWITH \"'\")"];

	soundTypes = [soundTypes filteredArrayUsingPredicate:noHFSTypesPredicate];

	//If there are no types left, abort.

	if ([soundTypes count] == 0U)

		return unknownFormatErr;

	//We only want the filename extensions, not the HFS types.

	//Also, we want the longest one last so that we can use lastObject's length to allocate the buffer.

	NSSortDescriptor *sortDesc = [[[NSSortDescriptor alloc] initWithKey:@"length" ascending:YES] autorelease];

	NSArray *sortDescs = [NSArray arrayWithObject:sortDesc];

	soundTypes = [soundTypes sortedArrayUsingDescriptors:sortDescs];

	NSMutableArray *filenames = [NSMutableArray arrayWithCapacity:[soundTypes count]];

	NSEnumerator *soundTypeEnum;

	NSString *soundType;

	soundTypeEnum = [soundTypes objectEnumerator];

	while ((soundType = [soundTypeEnum nextObject])) {

		[filenames addObject:[soundName stringByAppendingPathExtension:soundType]];

	}

	NSEnumerator *filenamesEnum;

	NSString *filename;

	//The additions are for appending '.' plus the longest filename extension.

	size_t filenameLen = [soundName length] + 1U + [[soundTypes lastObject] length];

	unichar *filenameBuf = malloc(filenameLen * sizeof(unichar));

	if (!filenameBuf) return memFullErr;

	FSRef folderRef;

	OSStatus err;

	err = FSFindFolder(kUserDomain, kSystemSoundsFolderType, kDontCreateFolder, &folderRef);

	if (err == noErr) {

		//Folder exists. If it didn't, FSFindFolder would have returned fnfErr.

		filenamesEnum = [filenames objectEnumerator];

		while ((filename = [filenamesEnum nextObject])) {

			[filename getCharacters:filenameBuf];

			err = FSMakeFSRefUnicode(&folderRef, [filename length], filenameBuf, kTextEncodingUnknown, outRef);

			if (err == noErr) {

				foundIt = YES;

				break;

			}

		}

	}

	if (!foundIt) {

		err = FSFindFolder(kLocalDomain, kSystemSoundsFolderType, kDontCreateFolder, &folderRef);

		if (err == noErr) {

			//Folder exists. If it didn't, FSFindFolder would have returned fnfErr.

			filenamesEnum = [filenames objectEnumerator];

			while ((filename = [filenamesEnum nextObject])) {

				[filename getCharacters:filenameBuf];

				err = FSMakeFSRefUnicode(&folderRef, [filename length], filenameBuf, kTextEncodingUnknown, outRef);

				if (err == noErr) {

					foundIt = YES;

					break;

				}

			}

		}

	}

	if (!foundIt) {

		err = FSFindFolder(kSystemDomain, kSystemSoundsFolderType, kDontCreateFolder, &folderRef);

		if (err == noErr) {

			//Folder exists. If it didn't, FSFindFolder would have returned fnfErr.

			filenamesEnum = [filenames objectEnumerator];

			while ((filename = [filenamesEnum nextObject])) {

				[filename getCharacters:filenameBuf];

				err = FSMakeFSRefUnicode(&folderRef, [filename length], filenameBuf, kTextEncodingUnknown, outRef);

				if (err == noErr) {

					foundIt = YES;

					break;

				}

			}

		}

	}

	free(filenameBuf);

	return err;

}

#pragma mark Dispatching notifications

- (void) dispatchNotificationWithDictionary:(NSDictionary *) dict {

	NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

	[[GrowlLog sharedController] writeNotificationDictionaryToLog:dict];

	// Make sure this notification is actually registered

	NSString *appName = [dict objectForKey:GROWL_APP_NAME];

	GrowlApplicationTicket *ticket = [ticketController ticketForApplicationName:appName];

	NSString *notificationName = [dict objectForKey:GROWL_NOTIFICATION_NAME];

	if (!ticket || ![ticket isNotificationAllowed:notificationName]) {

		// Either the app isn't registered or the notification is turned off

		// We should do nothing

		[pool release];

		return;

	}

	NSMutableDictionary *aDict = [dict mutableCopy];

	// Check icon

	Class NSImageClass = [NSImage class];

	Class NSDataClass  = [NSData  class];

	NSImage *icon = nil;

	id image = [aDict objectForKey:GROWL_NOTIFICATION_ICON];

	if (image) {

		if ([image isKindOfClass:NSImageClass])

			icon = [image copy];

		else if ([image isKindOfClass:NSDataClass])

			icon = [[NSImage alloc] initWithData:image];

	}

	if (!icon)

		icon = [[ticket icon] copy];

	if (icon) {

		[aDict setObject:icon forKey:GROWL_NOTIFICATION_ICON];

		[icon release];

	} else {

		//We get here when no image existed, and if an NSData existed, an image could not be created from it.

		//In the latter case, we don't need to keep that non-image NSData around.

		[aDict removeObjectForKey:GROWL_NOTIFICATION_ICON];

	}

	// If app icon present, convert to NSImage

	icon = nil;

	image = [aDict objectForKey:GROWL_NOTIFICATION_APP_ICON];

	if (image) {

		if ([image isKindOfClass:NSImageClass])

			icon = [image copy];

		else if ([image isKindOfClass:NSDataClass])

			icon = [[NSImage alloc] initWithData:image];

	}

	if (icon) {

		[aDict setObject:icon forKey:GROWL_NOTIFICATION_APP_ICON];

		[icon release];

	} else

		[aDict removeObjectForKey:GROWL_NOTIFICATION_APP_ICON];

	// To avoid potential exceptions, make sure we have both text and title

	if (![aDict objectForKey:GROWL_NOTIFICATION_DESCRIPTION])

		[aDict setObject:@"" forKey:GROWL_NOTIFICATION_DESCRIPTION];

	if (![aDict objectForKey:GROWL_NOTIFICATION_TITLE])

		[aDict setObject:@"" forKey:GROWL_NOTIFICATION_TITLE];

	//Retrieve and set the the priority of the notification

	GrowlNotificationTicket *notification = [ticket notificationTicketForName:notificationName];

	int priority = [notification priority];

	NSNumber *value;

	if (priority == GrowlPriorityUnset) {

		value = [dict objectForKey:GROWL_NOTIFICATION_PRIORITY];

		if (!value)

			value = [NSNumber numberWithInt:0];

	} else

		value = [NSNumber numberWithInt:priority];

	[aDict setObject:value forKey:GROWL_NOTIFICATION_PRIORITY];

	GrowlPreferencesController *preferences = [GrowlPreferencesController sharedController];

	// Retrieve and set the sticky bit of the notification

	int sticky = [notification sticky];

	if (sticky >= 0)

		setBooleanForKey(aDict, GROWL_NOTIFICATION_STICKY, sticky);

	else if ([preferences stickyWhenAway] && !getBooleanForKey(aDict, GROWL_NOTIFICATION_STICKY))

		setBooleanForKey(aDict, GROWL_NOTIFICATION_STICKY, GrowlIdleStatusController_isIdle());

	BOOL saveScreenshot = [[NSUserDefaults standardUserDefaults] boolForKey:GROWL_SCREENSHOT_MODE];

	setBooleanForKey(aDict, GROWL_SCREENSHOT_MODE, saveScreenshot);

	setBooleanForKey(aDict, @"ClickHandlerEnabled", [ticket clickHandlersEnabled]);

	if (![preferences squelchMode]) {

		GrowlDisplayPlugin *display = [notification displayPlugin];

		if (!display)

			display = [ticket displayPlugin];

		if (!display) {

			if (!defaultDisplayPlugin) {

				NSString *displayPluginName = [[GrowlPreferencesController sharedController] defaultDisplayPluginName];

				defaultDisplayPlugin = [(GrowlDisplayPlugin *)[[GrowlPluginController sharedController] displayPluginInstanceWithName:displayPluginName author:nil version:nil type:nil] retain];

				if (!defaultDisplayPlugin) {

					//User's selected default display has gone AWOL. Change to the default default.

					NSString *file = [[NSBundle mainBundle] pathForResource:@"GrowlDefaults" ofType:@"plist"];

					NSURL *fileURL = [NSURL fileURLWithPath:file];

					NSDictionary *defaultDefaults = (NSDictionary *)createPropertyListFromURL((NSURL *)fileURL, kCFPropertyListImmutable, NULL, NULL);

					if (defaultDefaults) {

						displayPluginName = [defaultDefaults objectForKey:GrowlDisplayPluginKey];

						if (!displayPluginName)

							GrowlLog_log(@"No default display specified in default preferences! Perhaps your Growl installation is corrupted?");

						else {

							defaultDisplayPlugin = (GrowlDisplayPlugin *)[[[GrowlPluginController sharedController] displayPluginDictionaryWithName:displayPluginName author:nil version:nil type:nil] pluginInstance];

							//Now fix the user's preferences to forget about the missing display plug-in.

							[preferences setObject:displayPluginName forKey:GrowlDisplayPluginKey];

						}

						[defaultDefaults release];

					}

				}

			}

			display = defaultDisplayPlugin;

		}

		GrowlApplicationNotification *appNotification = [[GrowlApplicationNotification alloc] initWithDictionary:aDict];

		[display displayNotification:appNotification];

		[appNotification release];

		NSString *soundName = [notification sound];

		if (soundName) {

			NSError *error = nil;

			NSDictionary *userInfo;

			FSRef soundRef;

			OSStatus err = [self getFSRef:&soundRef forSoundNamed:soundName];

			if (err == noErr) {

				SystemSoundActionID actionID;

				err = SystemSoundGetActionID(&soundRef, &actionID);

				if (err == noErr) {

					err = SystemSoundSetCompletionRoutine(actionID, CFRunLoopGetCurrent(), /*runLoopMode*/ NULL, soundCompletionCallback, /*refcon*/ NULL);

					SystemSoundPlay(actionID);

					userInfo = nil;

				} else {

					userInfo = [NSDictionary dictionaryWithObjectsAndKeys:

						[NSString stringWithFormat:NSLocalizedString(@"Could not load and play sound file named \"%@\": %s", /*comment*/ nil), soundName, GetMacOSStatusCommentString(err)], NSLocalizedDescriptionKey,

						nil];

				}					

			} else {

				userInfo = [NSDictionary dictionaryWithObjectsAndKeys:

					[NSString stringWithFormat:NSLocalizedString(@"Could not find sound file named \"%@\": %s", /*comment*/ nil), soundName, GetMacOSStatusCommentString(err)], NSLocalizedDescriptionKey,

					nil];

			}

			if (err != noErr) {

				error = [NSError errorWithDomain:NSOSStatusErrorDomain code:err userInfo:userInfo];

				[NSApp presentError:error];

			}

		}

	}

	// send to DO observers

	[growlNotificationCenter notifyObservers:aDict];

	[aDict release];

	// forward to remote destinations

	if (enableForward && ![dict objectForKey:GROWL_REMOTE_ADDRESS]) {

		if ([NSThread currentThread] == mainThread)

			[NSThread detachNewThreadSelector:@selector(forwardNotification:)

									 toTarget:self

								   withObject:dict];

		else

			[self forwardNotification:dict];

	}

	[pool release];

}

- (BOOL) registerApplicationWithDictionary:(NSDictionary *)userInfo {

	[[GrowlLog sharedController] writeRegistrationDictionaryToLog:userInfo];

	NSString *appName = [userInfo objectForKey:GROWL_APP_NAME];

	GrowlApplicationTicket *newApp = [ticketController ticketForApplicationName:appName];

	if (newApp) {

		[newApp reregisterWithDictionary:userInfo];

	} else {

		newApp = [[[GrowlApplicationTicket alloc] initWithDictionary:userInfo] autorelease];

	}

	BOOL success = YES;

	if (appName && newApp) {

		if ([newApp hasChanged])

			[newApp saveTicket];

		[ticketController addTicket:newApp];

		if (enableForward && ![userInfo objectForKey:GROWL_REMOTE_ADDRESS]) {

			if ([NSThread currentThread] == mainThread)

				[NSThread detachNewThreadSelector:@selector(forwardRegistration:)

										 toTarget:self

									   withObject:userInfo];

			else

				[self forwardRegistration:userInfo];

		}

	} else { //!(appName && newApp)

		NSString *filename = [(appName ? appName : @"unknown-application") stringByAppendingPathExtension:GROWL_REG_DICT_EXTENSION];

		//We'll be writing the file to ~/Library/Logs/Failed Growl registrations.

		NSFileManager *mgr = [NSFileManager defaultManager];

		NSString *userLibraryFolder = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, /*expandTilde*/ YES) lastObject];

		NSString *logsFolder = [userLibraryFolder stringByAppendingPathComponent:@"Logs"];

		[mgr createDirectoryAtPath:logsFolder attributes:nil];

		NSString *failedTicketsFolder = [logsFolder stringByAppendingPathComponent:@"Failed Growl registrations"];

		[mgr createDirectoryAtPath:failedTicketsFolder attributes:nil];

		NSString *path = [failedTicketsFolder stringByAppendingPathComponent:filename];

		//NSFileHandle will not create the file for us, so we must create it separately.

		[mgr createFileAtPath:path contents:nil attributes:nil];

		NSFileHandle *fh = [NSFileHandle fileHandleForWritingAtPath:path];

		[fh seekToEndOfFile];

		if ([fh offsetInFile]) //we are not at the beginning of the file

			[fh writeData:[@"\n---\n\n" dataUsingEncoding:NSUTF8StringEncoding]];

		[fh writeData:[[[userInfo description] stringByAppendingString:@"\n"] dataUsingEncoding:NSUTF8StringEncoding]];

		[fh closeFile];

		if (!appName) appName = @"with no name";

		NSLog(@"Failed application registration for application %@; wrote failed registration dictionary %p to %@", appName, userInfo, path);

		success = NO;

	}

	return success;

}

#pragma mark Version of Growl

+ (NSString *) growlVersion {

	return [[NSBundle mainBundle] objectForInfoDictionaryKey:(NSString *)kCFBundleVersionKey];

}

- (NSDictionary *) versionDictionary {

	if (!versionInfo) {

		if (version.releaseType == releaseType_svn)

			version.development = strtoul(SVN_REVISION, /*endptr*/ NULL, 10);

		NSNumber *major = [[NSNumber alloc] initWithUnsignedShort:version.major];

		NSNumber *minor = [[NSNumber alloc] initWithUnsignedShort:version.minor];

		NSNumber *incremental = [[NSNumber alloc] initWithUnsignedChar:version.incremental];

		NSNumber *releaseType = [[NSNumber alloc] initWithUnsignedChar:version.releaseType];

		NSNumber *development = [[NSNumber alloc] initWithUnsignedShort:version.development];

		versionInfo = [[NSDictionary alloc] initWithObjectsAndKeys:

			[GrowlApplicationController growlVersion], (NSString *)kCFBundleVersionKey,

			major,                                     @"Major version",

			minor,                                     @"Minor version",

			incremental,                               @"Incremental version",

			releaseTypeNames[version.releaseType],     @"Release type name",

			releaseType,                               @"Release type",

			development,                               @"Development version",

			nil];

		[major       release];

		[minor       release];

		[incremental release];

		[releaseType release];

		[development release];

	}

	return versionInfo;

}

//this method could be moved to Growl.framework, I think.

//pass nil to get GrowlHelperApp's version as a string.

- (NSString *)stringWithVersionDictionary:(NSDictionary *)d {

	if (!d)

		d = [self versionDictionary];

	//0.6

	NSMutableString *result = [NSMutableString stringWithFormat:@"%@.%@",

		[d objectForKey:@"Major version"],

		[d objectForKey:@"Minor version"]];

	//the .1 in 0.6.1

	NSNumber *incremental = [d objectForKey:@"Incremental version"];

	if ([incremental unsignedShortValue])

		[result appendFormat:@".%@", incremental];

	NSString *releaseTypeName = [d objectForKey:@"Release type name"];

	if ([releaseTypeName length]) {

		//"" (release), "b4", " SVN 900"

		[result appendFormat:@"%@%@", releaseTypeName, [d objectForKey:@"Development version"]];

	}

	return result;

}

- (NSURL *) versionCheckURL {

	if (!versionCheckURL)

		versionCheckURL = [[NSURL URLWithString:@"http://growl.info/version.xml"] retain];

	return versionCheckURL;

}

#pragma mark Accessors

- (BOOL) quitAfterOpen {

	return quitAfterOpen;

}

- (void) setQuitAfterOpen:(BOOL)flag {

	quitAfterOpen = flag;

}

#pragma mark What NSThread should implement as a class method

- (NSThread *)mainThread {

	return mainThread;

}

#pragma mark Notifications (not the Growl kind)

- (void) preferencesChanged:(NSNotification *) note {

	NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

	//[note object] is the changed key. A nil key means reload our tickets.

	id object = [note object];

	if (!quitAfterOpen) {

		if (!note || (object && [object isEqual:GrowlStartServerKey])) {

			Class pathwayControllerClass = NSClassFromString(@"GrowlPathwayController");

			if (pathwayControllerClass)

				[(id)[pathwayControllerClass sharedController] setServerEnabledFromPreferences];

		}

	}

	if (!note || (object && [object isEqual:GrowlUserDefaultsKey]))

		[[GrowlPreferencesController sharedController] synchronize];

	if (!note || (object && [object isEqual:GrowlEnabledKey]))

		growlIsEnabled = [[GrowlPreferencesController sharedController] boolForKey:GrowlEnabledKey];

	if (!note || (object && [object isEqual:GrowlEnableForwardKey]))

		enableForward = [[GrowlPreferencesController sharedController] isForwardingEnabled];

	if (!note || (object && [object isEqual:GrowlForwardDestinationsKey])) {

		[destinations release];

		destinations = [[[GrowlPreferencesController sharedController] objectForKey:GrowlForwardDestinationsKey] retain];

	}

	if (!note || !object)

		[ticketController loadAllSavedTickets];

	if (!note || (object && [object isEqual:GrowlDisplayPluginKey]))

		// force reload

		[defaultDisplayPlugin release];

		defaultDisplayPlugin = nil;

	if (object) {

		if ([object isEqual:@"GrowlTicketDeleted"]) {

			NSString *ticketName = [[note userInfo] objectForKey:@"TicketName"];

			[ticketController removeTicketForApplicationName:ticketName];

		} else if ([object isEqual:@"GrowlTicketChanged"]) {

			NSString *ticketName = [[note userInfo] objectForKey:@"TicketName"];

			GrowlApplicationTicket *newTicket = [[GrowlApplicationTicket alloc] initTicketForApplication:ticketName];

			if (newTicket) {

				[ticketController addTicket:newTicket];

				[newTicket release];

			}

		} else if ((!quitAfterOpen) && [object isEqual:GrowlUDPPortKey]) {

			Class pathwayControllerClass = NSClassFromString(@"GrowlPathwayController");

			if (pathwayControllerClass) {

				id pathwayController = [pathwayControllerClass sharedController];

				[pathwayController setServerEnabled:NO];

				[pathwayController setServerEnabled:YES];

			}

		}

	}

	[pool release];

}

- (void) shutdown:(NSNotification *) note {

#pragma unused(note)

	[NSApp terminate:nil];

}

- (void) replyToPing:(NSNotification *) note {

#pragma unused(note)

	NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

	[[NSDistributedNotificationCenter defaultCenter] postNotificationName:GROWL_PONG

	                                                               object:nil

	                                                             userInfo:nil

	                                                   deliverImmediately:NO];

	[pool release];

}

#pragma mark NSApplication Delegate Methods

- (BOOL) application:(NSApplication *)theApplication openFile:(NSString *)filename {

#pragma unused(theApplication)

	BOOL retVal = NO;

	NSString *pathExtension = [filename pathExtension];

	if ([pathExtension isEqualToString:GROWL_REG_DICT_EXTENSION]) {

		//If the auto-quit flag is set, it's probably because we are not the real GHAÑwe're some other GHA that a broken (pre-1.1.3) GAB opened this file with. If that's the case, find the real one and open the file with it.

		BOOL registerItOurselves = YES;

		NSString *realHelperAppBundlePath = nil;

		if (quitAfterOpen) {

			//But, just to make sure we don't infinitely loop, make sure this isn't our own bundle.

			NSString *ourBundlePath = [[NSBundle mainBundle] bundlePath];

			realHelperAppBundlePath = [[GrowlPathUtilities runningHelperAppBundle] bundlePath];

			if (![ourBundlePath isEqualToString:realHelperAppBundlePath])

				registerItOurselves = NO;

		}

		if (registerItOurselves) {

			//We are the real GHA.

			//Have the property-list-file pathway process this registration dictionary file.

			GrowlPropertyListFilePathway *pathway = [GrowlPropertyListFilePathway standardPathway];

			[pathway application:theApplication openFile:filename];

		} else {

			//We're definitely not the real GHA, so pass it to the real GHA to be registered.

			[[NSWorkspace sharedWorkspace] openFile:filename

									withApplication:realHelperAppBundlePath];

		}

	} else {

		GrowlPluginController *controller = [GrowlPluginController sharedController];

		//the set returned by GrowlPluginController is case-insensitive. yay!

		if ([[controller registeredPluginTypes] containsObject:pathExtension]) {

			[controller installPluginFromPath:filename];

			retVal = YES;

		}

	}

	/*If Growl is not enabled and was not already running before

	 *	(for example, via an autolaunch even though the user's last

	 *	preference setting was to click "Stop Growl," setting enabled to NO),

	 *	quit having registered; otherwise, remain running.

	 */

	if (!growlIsEnabled && !growlFinishedLaunching) {

		//Terminate after one second to give us time to process any other openFile: messages.

		[NSObject cancelPreviousPerformRequestsWithTarget:NSApp