Fixed a small memory leak in PreferencesController and keychain access.
[MenuTunes.git] / PreferencesController.m
index 0599859..0a796dc 100755 (executable)
@@ -6,6 +6,7 @@
 #import "StatusWindow.h"
 #import "StatusWindowController.h"
 #import "CustomMenuTableView.h"
+#import "AudioscrobblerController.h"
 
 #import <Security/Security.h>
 
 #import <sys/types.h>
 #import <sys/stat.h>
 
-#import <ITKit/ITLoginItem.h>
-
-#import <ITKit/ITHotKeyCenter.h>
-#import <ITKit/ITKeyCombo.h>
-#import <ITKit/ITKeyComboPanel.h>
-#import <ITKit/ITWindowPositioning.h>
-#import <ITKit/ITKeyBroadcaster.h>
-
+#import <ITKit/ITKit.h>
 #import <ITKit/ITTSWBackgroundView.h>
-#import <ITKit/ITWindowEffect.h>
-#import <ITKit/ITCutWindowEffect.h>
-#import <ITKit/ITDissolveWindowEffect.h>
-#import <ITKit/ITSlideHorizontallyWindowEffect.h>
-#import <ITKit/ITSlideVerticallyWindowEffect.h>
-#import <ITKit/ITPivotWindowEffect.h>
-
 
 #define SENDER_STATE (([sender state] == NSOnState) ? YES : NO)
-#define AUDIOSCROBBLER_KEYCHAIN_SERVICE "MenuTunes: Audioscrobbler"
+#define AUDIOSCROBBLER_KEYCHAIN_SERVICE(user) [[NSString stringWithFormat:@"Audioscrobbler: %@", user] UTF8String]
 #define AUDIOSCROBBLER_KEYCHAIN_KIND "application password"
 
 /*************************************************************************/
 /*************************************************************************/
 
 @interface PreferencesController (Private)
++ (SecKeychainItemRef)keychainItemForUser:(NSString *)user;
++ (BOOL)keychainItemExistsForUser:(NSString *)user;
++ (BOOL)createKeychainItemForUser:(NSString *)user andPassword:(NSString *)password;
++ (BOOL)deleteKeychainItemForUser:(NSString *)user;
++ (BOOL)setKeychainItemPassword:(NSString *)password forUser:(NSString *)user;
+
 - (void)setupWindow;
 - (void)setupCustomizationTables;
 - (void)setupMenuItems;
 - (void)repopulateEffectPopupsForVerticalPosition:(ITVerticalWindowPosition)vPos horizontalPosition:(ITHorizontalWindowPosition)hPos;
 - (BOOL)effect:(Class)effectClass supportsVerticalPosition:(ITVerticalWindowPosition)vPos withHorizontalPosition:(ITHorizontalWindowPosition)hPos;
 - (IBAction)changeMenus:(id)sender;
-
-- (SecKeychainItemRef)keychainItemForUser:(NSString *)user;
-- (BOOL)keychainItemExistsForUser:(NSString *)user;
-- (BOOL)createKeychainItemForUser:(NSString *)user andPassword:(NSString *)password;
-- (BOOL)deleteKeychainItemForUser:(NSString *)user;
-- (BOOL)setKeychainItemPassword:(NSString *)password forUser:(NSString *)user;
 @end
 
 
 
 static PreferencesController *prefs = nil;
 
+/*************************************************************************/
+#pragma mark -
+#pragma mark STATIC KEYCHAIN SUPPORT METHODS
+/*************************************************************************/
+
++ (SecKeychainItemRef)keychainItemForUser:(NSString *)user
+{
+       SecKeychainSearchRef search;
+       SecKeychainItemRef item;
+       OSStatus status;
+       SecKeychainAttribute attributes[3];
+       SecKeychainAttributeList list;
+
+       if ((user == nil) || ([user length] == 0)) {
+               return nil;
+       }
+
+       ITDebugLog(@"Audioscrobbler: Searching for keychain item for %@.", user);
+       attributes[0].tag = kSecAccountItemAttr;
+       attributes[0].data = (char *)[user UTF8String];
+       attributes[0].length = [user length];
+       attributes[1].tag = kSecDescriptionItemAttr;
+       attributes[1].data = AUDIOSCROBBLER_KEYCHAIN_KIND;
+       attributes[1].length = strlen(AUDIOSCROBBLER_KEYCHAIN_KIND);
+       attributes[2].tag = kSecLabelItemAttr;
+       attributes[2].data = (char *)AUDIOSCROBBLER_KEYCHAIN_SERVICE(user);
+       attributes[2].length = strlen(AUDIOSCROBBLER_KEYCHAIN_SERVICE(user));
+       list.count = 3;
+       list.attr = attributes;
+
+       status = SecKeychainSearchCreateFromAttributes(NULL, kSecGenericPasswordItemClass, &list, &search);
+
+       if (status != noErr) {
+               ITDebugLog(@"Audioscrobbler: Error searching for existing keychain item: %i", status);
+       }
+       
+       status = SecKeychainSearchCopyNext(search, &item);
+       
+       if (status != noErr) {
+               ITDebugLog(@"Audioscrobbler: Error searching for existing keychain item: %i", status);
+               item = nil;
+       }
+       
+    CFRelease(search);
+       return item;
+}
+
++ (BOOL)keychainItemExistsForUser:(NSString *)user
+{
+       SecKeychainItemRef item = [PreferencesController keychainItemForUser:user];
+       BOOL exists = (item != nil);
+       if (item) {
+               CFRelease(item);
+       }
+       return exists;
+}
+
++ (BOOL)createKeychainItemForUser:(NSString *)user andPassword:(NSString *)password
+{
+       SecKeychainItemRef item;
+       OSStatus status;
+       SecKeychainAttribute attributes[3];
+       SecKeychainAttributeList list;
+
+       ITDebugLog(@"Audioscrobbler: Creating new keychain item for %@.", user);
+       attributes[0].tag = kSecAccountItemAttr;
+       attributes[0].data = (char *)[user UTF8String];
+       attributes[0].length = [user length];
+       attributes[1].tag = kSecDescriptionItemAttr;
+       attributes[1].data = AUDIOSCROBBLER_KEYCHAIN_KIND;
+       attributes[1].length = strlen(AUDIOSCROBBLER_KEYCHAIN_KIND);
+       attributes[2].tag = kSecLabelItemAttr;
+       attributes[2].data = (char *)AUDIOSCROBBLER_KEYCHAIN_SERVICE(user);
+       attributes[2].length = strlen(AUDIOSCROBBLER_KEYCHAIN_SERVICE(user));
+       list.count = 3;
+       list.attr = attributes;
+
+       status = SecKeychainItemCreateFromContent(kSecGenericPasswordItemClass, &list, [password length], [password UTF8String], NULL, NULL, &item);
+       if (status != noErr) {
+               ITDebugLog(@"Audioscrobbler: Error creating keychain item: %i", status);
+       }
+       return (status == noErr);
+}
+
++ (BOOL)deleteKeychainItemForUser:(NSString *)user
+{
+       OSStatus status = errSecNotAvailable;
+       SecKeychainItemRef item = [PreferencesController keychainItemForUser:user];
+       if (item != nil) {
+               status = SecKeychainItemDelete(item);
+               if (status != noErr) {
+                       ITDebugLog(@"Audioscrobbler: Error deleting keychain item: %i", status);
+               }
+               CFRelease(item);
+       }
+       return (status == noErr);
+}
+
++ (BOOL)setKeychainItemPassword:(NSString *)password forUser:(NSString *)user
+{
+       OSStatus status = errSecNotAvailable;
+       SecKeychainItemRef item = [PreferencesController keychainItemForUser:user];
+       if (item != nil) {
+               status = SecKeychainItemModifyContent(item, NULL, [password length], [password UTF8String]);
+               if (status != noErr) {
+                       ITDebugLog(@"Audioscrobbler: Error deleting keychain item: %i", status);
+               }
+               CFRelease(item);
+       }
+       return (status == noErr);
+}
+
++ (NSString *)getKeychainItemPasswordForUser:(NSString *)user
+{
+       OSStatus status = errSecNotAvailable;
+       SecKeychainItemRef item = [PreferencesController keychainItemForUser:user];
+       NSString *pass = nil;
+       if (item != nil) {
+               UInt32 length;
+               char *buffer;
+               status = SecKeychainItemCopyContent(item, NULL, NULL, &length, (void **)&buffer);
+               if (status != noErr) {
+                       ITDebugLog(@"Audioscrobbler: Error getting keychain item password: %i", status);
+               } else {
+                       NSLog(@"Audioscrobbler: password buffer: \"%s\" \"Length: %i\"", buffer, length);
+                       pass = [[NSString alloc] initWithBytes:buffer length:length encoding:NSUTF8StringEncoding];
+               }
+               if (status != noErr) {
+                       ITDebugLog(@"Audioscrobbler: Error deleting keychain item: %i", status);
+               }
+               SecKeychainItemFreeContent(NULL, buffer);
+               CFRelease(item);
+       }
+       NSLog(@"Audioscrobbler: Retrieved password: \"%@\"", pass);
+       return [pass autorelease];
+}
 
 /*************************************************************************/
 #pragma mark -
@@ -101,6 +224,7 @@ static PreferencesController *prefs = nil;
                                                        @"Rewind",
                                                        @"ShowPlayer",
                                                        @"TrackInfo",
+                                                                                                          @"AlbumArt",
                                                        @"UpcomingSongs",
                                                        @"IncrementVolume",
                                                        @"DecrementVolume",
@@ -125,6 +249,7 @@ static PreferencesController *prefs = nil;
                                                        @"Rewind",
                                                        @"Show Player",
                                                        @"Track Info",
+                                                                                                          @"Album Art",
                                                        @"Upcoming Songs",
                                                        @"Increment Volume",
                                                        @"Decrement Volume",
@@ -139,7 +264,7 @@ static PreferencesController *prefs = nil;
                                                        [NSString stringWithUTF8String:"Set Rating: ★★☆☆☆"],
                                                        [NSString stringWithUTF8String:"Set Rating: ★★★☆☆"],
                                                        [NSString stringWithUTF8String:"Set Rating: ★★★★☆"],
-                                                       [NSString stringWithUTF8String:"Set Rating: ★★★★"],
+                                                       [NSString stringWithUTF8String:"Set Rating: ★★★★"],
                                                        nil];
         hotKeysDictionary = [[NSMutableDictionary alloc] init];
         controller = nil;
@@ -280,7 +405,7 @@ static PreferencesController *prefs = nil;
             [showScriptsButton setEnabled:NO];
         }
     } else if ( [sender tag] == 1120) {
-        mkdir([[NSHomeDirectory() stringByAppendingPathComponent:@"Library/Application Support/MenuTunes/Scripts"] cString], 0744);
+        mkdir([[NSHomeDirectory() stringByAppendingPathComponent:@"Library/Application Support/MenuTunes/Scripts"] UTF8String], 0744);
         [[NSWorkspace sharedWorkspace] openFile:[NSHomeDirectory() stringByAppendingPathComponent:@"Library/Application Support/MenuTunes/Scripts"]];
     } else if ( [sender tag] == 6010) {
                //Toggle the other Audioscrobbler options
@@ -288,29 +413,33 @@ static PreferencesController *prefs = nil;
                [audioscrobblerUseCacheCheckbox setEnabled:SENDER_STATE];
                [audioscrobblerUserTextField setEnabled:SENDER_STATE];
                [audioscrobblerPasswordTextField setEnabled:SENDER_STATE];
+               if (SENDER_STATE) {
+                       [[AudioscrobblerController sharedController] attemptHandshake:NO];
+               }
        } else if ( [sender tag ] == 6015) {
                //Here we create a new keychain item if needed and deletes the keychain item if the field is cleared.
                NSString *currentAccount = [df stringForKey:@"audioscrobblerUser"], *newAccount = [sender stringValue];
                if ([newAccount length] == 0) {
-                       [self deleteKeychainItemForUser:currentAccount];
+                       [PreferencesController deleteKeychainItemForUser:currentAccount];
                } else if (![currentAccount isEqualToString:newAccount] && [[audioscrobblerPasswordTextField stringValue] length] > 0) {
                        [df setObject:newAccount forKey:@"audioscrobblerUser"];
-                       if ([self keychainItemExistsForUser:currentAccount]) {
+                       if ([PreferencesController keychainItemExistsForUser:currentAccount]) {
                                //Delete the current keychain item if there is one
-                               [self deleteKeychainItemForUser:currentAccount];
+                               [PreferencesController deleteKeychainItemForUser:currentAccount];
                        }
-                       [self createKeychainItemForUser:newAccount andPassword:[audioscrobblerPasswordTextField stringValue]];
+                       [PreferencesController createKeychainItemForUser:newAccount andPassword:[audioscrobblerPasswordTextField stringValue]];
+                       [[AudioscrobblerController sharedController] attemptHandshake:YES];
                }
        } else if ( [sender tag ] == 6030) {
                //Here we set the password for an existing keychain item or we create a new keychain item.
                if ([[audioscrobblerUserTextField stringValue] length] > 0) {
                        NSString *account = [df stringForKey:@"audioscrobblerUser"];
-                       if ([self keychainItemExistsForUser:account]) {
+                       if ([PreferencesController keychainItemExistsForUser:account]) {
                                //Update the current keychain item
-                               [self setKeychainItemPassword:[sender stringValue] forUser:account];
+                               [PreferencesController setKeychainItemPassword:[sender stringValue] forUser:account];
                        } else if ([[sender stringValue] length] > 0 && [[audioscrobblerUserTextField stringValue] length]) {
                                //Create a new keychain item
-                               [self createKeychainItemForUser:account andPassword:[sender stringValue]];
+                               [PreferencesController createKeychainItemForUser:account andPassword:[sender stringValue]];
                        }
                }
        } else if ( [sender tag] == 6045) {
@@ -468,7 +597,7 @@ static PreferencesController *prefs = nil;
 
 - (IBAction)changeStatusWindowSetting:(id)sender
 {
-    StatusWindow *sw = [StatusWindow sharedWindow];
+    StatusWindow *sw = (StatusWindow *)[StatusWindow sharedWindow];
     ITDebugLog(@"Changing status window setting of tag %i", [sender tag]);
     
     if ( [sender tag] == 2010) {
@@ -690,140 +819,6 @@ static PreferencesController *prefs = nil;
     }
 }
 
-/*************************************************************************/
-#pragma mark -
-#pragma mark KEYCHAIN SUPPORT METHODS
-/*************************************************************************/
-
-- (SecKeychainItemRef)keychainItemForUser:(NSString *)user
-{
-       SecKeychainSearchRef search;
-       SecKeychainItemRef item;
-       OSStatus status;
-       SecKeychainAttribute attributes[3];
-       SecKeychainAttributeList list;
-
-       ITDebugLog(@"Audioscrobbler: Searching for keychain item for %@.", user);
-       attributes[0].tag = kSecAccountItemAttr;
-       attributes[0].data = (char *)[user UTF8String];
-       attributes[0].length = [user length];
-       attributes[1].tag = kSecDescriptionItemAttr;
-       attributes[1].data = AUDIOSCROBBLER_KEYCHAIN_KIND;
-       attributes[1].length = strlen(AUDIOSCROBBLER_KEYCHAIN_KIND);
-       attributes[2].tag = kSecLabelItemAttr;
-       attributes[2].data = AUDIOSCROBBLER_KEYCHAIN_SERVICE;
-       attributes[2].length = strlen(AUDIOSCROBBLER_KEYCHAIN_SERVICE);
-       list.count = 3;
-       list.attr = attributes;
-
-       status = SecKeychainSearchCreateFromAttributes(NULL, kSecGenericPasswordItemClass, &list, &search);
-
-       if (status != noErr) {
-               ITDebugLog(@"Audioscrobbler: Error searching for existing keychain item: %i", status);
-       }
-       
-       status = SecKeychainSearchCopyNext(search, &item);
-       
-       if (status != noErr) {
-               ITDebugLog(@"Audioscrobbler: Error searching for existing keychain item: %i", status);
-               item = nil;
-       }
-       
-    CFRelease(search);
-       return item;
-}
-
-- (BOOL)keychainItemExistsForUser:(NSString *)user
-{
-       SecKeychainItemRef item = [self keychainItemForUser:user];
-       BOOL exists = (item != nil);
-       if (item) {
-               CFRelease(item);
-       }
-       return exists;
-}
-
-- (BOOL)createKeychainItemForUser:(NSString *)user andPassword:(NSString *)password
-{
-       SecKeychainItemRef item;
-       OSStatus status;
-       SecKeychainAttribute attributes[3];
-       SecKeychainAttributeList list;
-
-       ITDebugLog(@"Audioscrobbler: Creating new keychain item for %@.", user);
-       attributes[0].tag = kSecAccountItemAttr;
-       attributes[0].data = (char *)[user UTF8String];
-       attributes[0].length = [user length];
-       attributes[1].tag = kSecDescriptionItemAttr;
-       attributes[1].data = AUDIOSCROBBLER_KEYCHAIN_KIND;
-       attributes[1].length = strlen(AUDIOSCROBBLER_KEYCHAIN_KIND);
-       attributes[2].tag = kSecLabelItemAttr;
-       attributes[2].data = AUDIOSCROBBLER_KEYCHAIN_SERVICE;
-       attributes[2].length = strlen(AUDIOSCROBBLER_KEYCHAIN_SERVICE);
-       list.count = 3;
-       list.attr = attributes;
-
-       status = SecKeychainItemCreateFromContent(kSecGenericPasswordItemClass, &list, [password length], [password UTF8String], NULL, NULL, &item);
-       if (status != noErr) {
-               ITDebugLog(@"Audioscrobbler: Error creating keychain item: %i", status);
-       }
-       return (status == noErr);
-}
-
-- (BOOL)deleteKeychainItemForUser:(NSString *)user
-{
-       OSStatus status = errSecNotAvailable;
-       SecKeychainItemRef item = [self keychainItemForUser:user];
-       if (item != nil) {
-               status = SecKeychainItemDelete(item);
-               if (status != noErr) {
-                       ITDebugLog(@"Audioscrobbler: Error deleting keychain item: %i", status);
-               }
-               CFRelease(item);
-       }
-       return (status == noErr);
-}
-
-- (BOOL)setKeychainItemPassword:(NSString *)password forUser:(NSString *)user
-{
-       OSStatus status = errSecNotAvailable;
-       SecKeychainItemRef item = [self keychainItemForUser:user];
-       if (item != nil) {
-               status = SecKeychainItemModifyContent(item, NULL, [password length], [password cString]);
-               if (status != noErr) {
-                       ITDebugLog(@"Audioscrobbler: Error deleting keychain item: %i", status);
-               }
-               CFRelease(item);
-       }
-       return (status == noErr);
-}
-
-- (NSString *)getKeychainItemPasswordForUser:(NSString *)user
-{
-       OSStatus status = errSecNotAvailable;
-       SecKeychainItemRef item = [self keychainItemForUser:user];
-       NSString *pass = nil;
-       if (item != nil) {
-               UInt32 length;
-               char *buffer;
-               status = SecKeychainItemCopyContent(item, NULL, NULL, &length, (void **)&buffer);
-               if (status != noErr) {
-                       ITDebugLog(@"Audioscrobbler: Error getting keychain item password: %i", status);
-               } else {
-                       if ([NSString respondsToSelector:@selector(stringWithCString:encoding:)]) {
-                               pass = [NSString stringWithCString:buffer encoding:NSASCIIStringEncoding];
-                       } else {
-                               pass = [NSString stringWithCString:buffer];
-                       }
-               }
-               if (status != noErr) {
-                       ITDebugLog(@"Audioscrobbler: Error deleting keychain item: %i", status);
-               }
-               CFRelease(item);
-       }
-       return pass;
-}
-
 /*************************************************************************/
 #pragma mark -
 #pragma mark HOTKEY SUPPORT METHODS
@@ -885,6 +880,11 @@ static PreferencesController *prefs = nil;
 #pragma mark PRIVATE METHOD IMPLEMENTATIONS
 /*************************************************************************/
 
+- (void)audioscrobblerStatusChanged:(NSNotification *)note
+{
+       [audioscrobblerStatusTextField setStringValue:[[note userInfo] objectForKey:@"StatusString"]];
+}
+
 - (void)setupWindow
 {
     ITDebugLog(@"Loading Preferences.nib.");
@@ -970,6 +970,12 @@ static PreferencesController *prefs = nil;
     int selectedBGStyle;
     id anItem;
        
+       [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(audioscrobblerStatusChanged:) name:@"AudioscrobblerStatusChanged" object:nil];
+       if ([df boolForKey:@"audioscrobblerEnabled"]) {
+               NSString *status = [[AudioscrobblerController sharedController] lastStatus];
+               [audioscrobblerStatusTextField setStringValue:(status == nil) ? @"Idle" : status];
+       }
+       
     [df setInteger:MT_CURRENT_VERSION forKey:@"appVersion"];
     
     ITDebugLog(@"Setting up preferences UI.");
@@ -1099,13 +1105,14 @@ static PreferencesController *prefs = nil;
                [audioscrobblerUseCacheCheckbox setEnabled:NO];
        }
        NSString *audioscrobblerUser = [df stringForKey:@"audioscrobblerUser"];
-       if (audioscrobblerUser != nil && [audioscrobblerUser length] > 0 && [self keychainItemExistsForUser:audioscrobblerUser]) {
-               NSString *password = [self getKeychainItemPasswordForUser:audioscrobblerUser];
+       if (audioscrobblerUser != nil && [audioscrobblerUser length] > 0 && [PreferencesController keychainItemExistsForUser:audioscrobblerUser]) {
+               NSString *password = [PreferencesController getKeychainItemPasswordForUser:audioscrobblerUser];
                [audioscrobblerUserTextField setStringValue:audioscrobblerUser];
                if (password != nil) {
                        [audioscrobblerPasswordTextField setStringValue:password];
                }
        }
+       [audioscrobblerUseCacheCheckbox setState:[df boolForKey:@"audioscrobblerCacheSubmissions"]];
        
     [[NSNotificationCenter defaultCenter] addObserver:sharingTableView selector:@selector(reloadData) name:@"ITMTFoundNetService" object:nil];
     
@@ -1160,7 +1167,7 @@ static PreferencesController *prefs = nil;
 
 - (void)setStatusWindowEntryEffect:(Class)effectClass
 {
-    StatusWindow *sw = [StatusWindow sharedWindow];
+    StatusWindow *sw = (StatusWindow *)[StatusWindow sharedWindow];
     
     float time = ([df floatForKey:@"statusWindowAppearanceSpeed"] ? [df floatForKey:@"statusWindowAppearanceSpeed"] : 0.8);
     [df setObject:NSStringFromClass(effectClass) forKey:@"statusWindowAppearanceEffect"];
@@ -1171,7 +1178,7 @@ static PreferencesController *prefs = nil;
 
 - (void)setStatusWindowExitEffect:(Class)effectClass
 {
-    StatusWindow *sw = [StatusWindow sharedWindow];
+    StatusWindow *sw = (StatusWindow *)[StatusWindow sharedWindow];
     
     float time = ([df floatForKey:@"statusWindowVanishSpeed"] ? [df floatForKey:@"statusWindowVanishSpeed"] : 0.8);
     [df setObject:NSStringFromClass(effectClass) forKey:@"statusWindowVanishEffect"];