Added a status field to the audioscrobbler preferences. Using alloc'd NSTimers in...
[MenuTunes.git] / AudioscrobblerController.m
index 32cb718..3864a0c 100644 (file)
  */
 
 #import "AudioscrobblerController.h"
+#import "PreferencesController.h"
 #import <openssl/evp.h>
 #import <ITFoundation/ITDebug.h>
 
+#define AUDIOSCROBBLER_ID @"mtu"
+#define AUDIOSCROBBLER_VERSION [[[NSBundle mainBundle] infoDictionary] objectForKey:@"CFBundleVersion"]
+
 static AudioscrobblerController *_sharedController = nil;
 
 @implementation AudioscrobblerController
 
-+ (void)load
-{
-       NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
-       [[AudioscrobblerController sharedController] submitTrack:@"Immigrant Song" artist:@"Led Zeppelin" album:@"How The West Was Won" length:221];
-       [[AudioscrobblerController sharedController] submitTrack:@"Comfortably Numb" artist:@"Pink Floyd" album:@"The Wall" length:384];
-       [[AudioscrobblerController sharedController] submitTracks];
-       [pool release];
-}
-
 + (AudioscrobblerController *)sharedController
 {
        if (!_sharedController) {
@@ -39,33 +34,51 @@ static AudioscrobblerController *_sharedController = nil;
 - (id)init
 {
        if ( (self = [super init]) ) {
-               /*_handshakeCompleted = NO;
+               _handshakeCompleted = NO;
                _md5Challenge = nil;
-               _postURL = nil;*/
+               _postURL = nil;
                
-               _handshakeCompleted = YES;
+               /*_handshakeCompleted = YES;
                _md5Challenge = @"rawr";
-               _postURL = [NSURL URLWithString:@"http://audioscrobbler.com/"];
+               _postURL = [NSURL URLWithString:@"http://audioscrobbler.com/"];*/
                
-               _delayDate = nil;
+               _delayDate = [[NSDate date] retain];
                _responseData = nil;
                _tracks = [[NSMutableArray alloc] init];
-               [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleAudioscrobblerNotification:) name:nil object:self];
+               _submitTracks = [[NSMutableArray alloc] init];
+               [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(handleAudioscrobblerNotification:) name:@"AudioscrobblerHandshakeComplete" object:self];
        }
        return self;
 }
 
 - (void)dealloc
 {
+       [_lastStatus release];
        [_md5Challenge release];
        [_postURL release];
        [_responseData release];
+       [_submitTracks release];
        [_tracks release];
+       [_delayDate release];
        [super dealloc];
 }
 
+- (NSString *)lastStatus
+{
+       return _lastStatus;
+}
+
 - (void)attemptHandshake
 {
+       [self attemptHandshake:NO];
+}
+
+- (void)attemptHandshake:(BOOL)force
+{
+       if (_handshakeCompleted && !force) {
+               return;
+       }
+       
        //Delay if we haven't met the interval time limit
        NSTimeInterval interval = [_delayDate timeIntervalSinceNow];
        if (interval > 0) {
@@ -74,13 +87,13 @@ static AudioscrobblerController *_sharedController = nil;
                return;
        }
        
-       if (!_handshakeCompleted) {
-               NSString *version = [[[NSBundle bundleWithPath:[[NSWorkspace sharedWorkspace] fullPathForApplication:@"iTunes.app"]] infoDictionary] objectForKey:@"CFBundleVersion"], *user = @"Tristrex";
-               NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"http://post.audioscrobbler.com/?hs=true&p=1.1&c=tst&v=%@&u=%@", version, user]];
-               NSURLConnection *connection;
+       NSString *user = [[NSUserDefaults standardUserDefaults] stringForKey:@"audioscrobblerUser"];
+       if (!_handshakeCompleted && user) {
+               NSURL *url = [NSURL URLWithString:[NSString stringWithFormat:@"http://post.audioscrobbler.com/?hs=true&p=1.1&c=%@&v=%@&u=%@", AUDIOSCROBBLER_ID, AUDIOSCROBBLER_VERSION, user]];
                
                _currentStatus = AudioscrobblerRequestingHandshakeStatus;
-               connection = [NSURLConnection connectionWithRequest:[NSURLRequest requestWithURL:url cachePolicy:NSURLRequestReloadIgnoringCacheData timeoutInterval:30] delegate:self];
+               _responseData = [[NSMutableData alloc] init];
+               [NSURLConnection connectionWithRequest:[NSURLRequest requestWithURL:url cachePolicy:NSURLRequestReloadIgnoringCacheData timeoutInterval:15] delegate:self];
        }
 }
 
@@ -91,16 +104,12 @@ static AudioscrobblerController *_sharedController = nil;
 
 - (void)submitTrack:(NSString *)title artist:(NSString *)artist album:(NSString *)album length:(int)length
 {
-       if (!_handshakeCompleted) {
-               [self attemptHandshake];
-               return;
-       }
        ITDebugLog(@"Audioscrobbler: Adding a new track to the submission queue.");
        NSDictionary *newTrack = [NSDictionary dictionaryWithObjectsAndKeys:title,
                                                                                                                                                @"title",
                                                                                                                                                artist,
                                                                                                                                                @"artist",
-                                                                                                                                               album,
+                                                                                                                                               (album == nil) ? @"" : album,
                                                                                                                                                @"album",
                                                                                                                                                [NSString stringWithFormat:@"%i", length],
                                                                                                                                                @"length",
@@ -108,29 +117,37 @@ static AudioscrobblerController *_sharedController = nil;
                                                                                                                                                @"time",
                                                                                                                                                nil, nil];
        [_tracks addObject:newTrack];
+       [self submitTracks];
 }
 
 - (void)submitTracks
 {
+       if (!_handshakeCompleted) {
+               [self attemptHandshake:NO];
+               return;
+       }
+       
+       NSString *user = [[NSUserDefaults standardUserDefaults] stringForKey:@"audioscrobblerUser"], *passString = [PreferencesController getKeychainItemPasswordForUser:user];
+       char *pass = (char *)[passString UTF8String];
+       
+       if (passString == nil) {
+               ITDebugLog(@"Audioscrobbler: Access denied to user password");
+               return;
+       }
+       
        NSTimeInterval interval = [_delayDate timeIntervalSinceNow];
        if (interval > 0) {
-               ITDebugLog(@"Audioscrobbler: Delaying track submission for %i seconds", interval);
-               [self performSelector:@selector(attemptHandshake) withObject:nil afterDelay:interval + 1];
+               ITDebugLog(@"Audioscrobbler: Delaying track submission for %f seconds", interval);
+               [self performSelector:@selector(submitTracks) withObject:nil afterDelay:interval + 1];
                return;
        }
        
        int i;
        NSMutableString *requestString;
        NSString *authString, *responseHash = @"";
-       char *pass = "waffles";
        unsigned char *buffer;
        EVP_MD_CTX ctx;
        
-       if (!_handshakeCompleted) {
-               [self attemptHandshake];
-               return;
-       }
-       
        ITDebugLog(@"Audioscrobbler: Submitting queued tracks");
        
        if ([_tracks count] == 0) {
@@ -161,26 +178,47 @@ static AudioscrobblerController *_sharedController = nil;
        }
        free(buffer);
        
-       authString = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)[NSString stringWithFormat:@"u=%@&s=%@", @"Tristrex", responseHash], NULL, NULL, kCFStringEncodingUTF8);
+       authString = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)[NSString stringWithFormat:@"u=%@&s=%@", user, responseHash], NULL, NULL, kCFStringEncodingUTF8);
        requestString = [[NSMutableString alloc] initWithString:authString];
        [authString release];
        
        //We can only submit ten tracks at a time
        for (i = 0; (i < [_tracks count]) && (i < 10); i++) {
                NSDictionary *nextTrack = [_tracks objectAtIndex:i];
-               NSString *trackString;
+               NSString *artistEscaped, *titleEscaped, *albumEscaped, *timeEscaped, *ampersand = @"&";
+               
+               //Escape each of the individual parameters we're sending
+               artistEscaped = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)[nextTrack objectForKey:@"artist"], NULL, (CFStringRef)ampersand, kCFStringEncodingUTF8);
+               titleEscaped = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)[nextTrack objectForKey:@"title"], NULL, (CFStringRef)ampersand, kCFStringEncodingUTF8);
+               albumEscaped = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)[nextTrack objectForKey:@"album"], NULL, (CFStringRef)ampersand, kCFStringEncodingUTF8);
+               timeEscaped = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)[nextTrack objectForKey:@"time"], NULL, (CFStringRef)ampersand, kCFStringEncodingUTF8);
+               
+               [requestString appendString:[NSString stringWithFormat:@"&a[%i]=%@&t[%i]=%@&b[%i]=%@&m[%i]=&l[%i]=%@&i[%i]=%@", i, artistEscaped,
+                                                                                                                                                                                                                                               i, titleEscaped,
+                                                                                                                                                                                                                                               i, albumEscaped,
+                                                                                                                                                                                                                                               i,
+                                                                                                                                                                                                                                               i, [nextTrack objectForKey:@"length"],
+                                                                                                                                                                                                                                               i, timeEscaped]];
                
-               trackString = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)[NSString stringWithFormat:@"&a[%i]=%@&t[%i]=%@&b[%i]=%@&m[%i]=&l[%i]=%@&i[%i]=%@", i, [nextTrack objectForKey:@"artist"], i, [nextTrack objectForKey:@"title"], i, [nextTrack objectForKey:@"album"], i, i, [nextTrack objectForKey:@"length"], i, [nextTrack objectForKey:@"time"]], NULL, NULL, kCFStringEncodingUTF8);
-               [requestString appendString:trackString];
-               [trackString release];
+               //Release the escaped strings
+               [artistEscaped release];
+               [titleEscaped release];
+               [albumEscaped release];
+               [timeEscaped release];
+               
+               [_submitTracks addObject:nextTrack];
        }
        
+       ITDebugLog(@"Audioscrobbler: Sending track submission request");
+       
        //Create and send the request
-       NSMutableURLRequest *request = [[NSURLRequest requestWithURL:_postURL cachePolicy:NSURLRequestReloadIgnoringCacheData timeoutInterval:30] mutableCopy];
+       NSMutableURLRequest *request = [[NSURLRequest requestWithURL:_postURL cachePolicy:NSURLRequestReloadIgnoringCacheData timeoutInterval:15] mutableCopy];
+       NSLog(@"Posting Audioscrobbler URL request: %@", requestString);
        [request setHTTPMethod:@"POST"];
        [request setHTTPBody:[requestString dataUsingEncoding:NSUTF8StringEncoding]];
        _currentStatus = AudioscrobblerSubmittingTracksStatus;
-       //[NSURLConnection connectionWithRequest:request delegate:self];
+       _responseData = [[NSMutableData alloc] init];
+       [NSURLConnection connectionWithRequest:request delegate:self];
        [requestString release];
        [request release];
        
@@ -189,13 +227,8 @@ static AudioscrobblerController *_sharedController = nil;
 
 - (void)handleAudioscrobblerNotification:(NSNotification *)note
 {
-       if ([[note name] isEqualToString:@"AudioscrobblerHandshakeComplete"]) {
-               if ([_tracks count] > 0) {
-                       [self submitTracks];
-               }
-               [self submitTrack:@"Immigrant Song" artist:@"Led Zeppelin" album:@"How The West Was Won" length:221];
-               [self submitTrack:@"Comfortably Numb" artist:@"Pink Floyd" album:@"The Wall" length:384];
-               [self submitTracks];
+       if ([_tracks count] > 0) {
+               [self performSelector:@selector(submitTracks) withObject:nil afterDelay:2];
        }
 }
 
@@ -203,6 +236,9 @@ static AudioscrobblerController *_sharedController = nil;
 
 - (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error
 {
+       [_lastStatus release];
+       _lastStatus = [[NSString stringWithFormat:NSLocalizedString(@"audioscrobbler_error", @"Error - %@"), [error localizedDescription]] retain];
+       [[NSNotificationCenter defaultCenter] postNotificationName:@"AudioscrobblerStatusChanged" object:self userInfo:[NSDictionary dictionaryWithObject:_lastStatus forKey:@"StatusString"]];
        ITDebugLog(@"Audioscrobbler: Connection error \"%@\"", error);
 }
 
@@ -215,64 +251,88 @@ static AudioscrobblerController *_sharedController = nil;
 {
        NSString *string = [[NSString alloc] initWithData:_responseData encoding:NSASCIIStringEncoding];
        NSArray *lines = [string componentsSeparatedByString:@"\n"];
-       NSString *responseAction = nil;
+       NSString *responseAction = nil, *key = nil, *comment = nil;
        
        if ([lines count] > 0) {
                responseAction = [lines objectAtIndex:0];
        }
-       
+       ITDebugLog(@"Audioscrobbler: Response %@", string);
+       NSLog(@"Audioscrobbler: Response %@", string);
        if (_currentStatus == AudioscrobblerRequestingHandshakeStatus) {
                if ([lines count] < 2) {
                        //We have a protocol error
                }
-               if ([responseAction isEqualToString:@"UPTODATE"]) {
+               if ([responseAction isEqualToString:@"UPTODATE"] || (([responseAction length] > 5) && [[responseAction substringToIndex:5] isEqualToString:@"UPDATE"])) {
                        if ([lines count] >= 4) {
                                _md5Challenge = [[lines objectAtIndex:1] retain];
                                _postURL = [[NSURL alloc] initWithString:[lines objectAtIndex:2]];
                                _handshakeCompleted = YES;
                                [[NSNotificationCenter defaultCenter] postNotificationName:@"AudioscrobblerHandshakeComplete" object:self];
+                               key = @"audioscrobbler_handshake_complete";
+                               comment = @"Handshake complete";
                        } else {
                                //We have a protocol error
                        }
-                       //Something
-               } else if (([responseAction length] > 5) && [[responseAction substringToIndex:5] isEqualToString:@"UPDATE"]) {
-                       //Something plus update action
                } else if (([responseAction length] > 5) && [[responseAction substringToIndex:5] isEqualToString:@"FAILED"]) {
+                       ITDebugLog(@"Audioscrobbler: Handshake failed (%@)", [responseAction substringFromIndex:6]);
+                       key = @"audioscrobbler_handshake_failed";
+                       comment = @"Handshake failed";
                        //We have a error
                } else if ([responseAction isEqualToString:@"BADUSER"]) {
+                       ITDebugLog(@"Audioscrobbler: Bad user name");
+                       key = @"audioscrobbler_bad_user";
+                       comment = @"Handshake failed - invalid user name";
                        //We have a bad user
                } else {
-                       //We have a protocol
+                       ITDebugLog(@"Audioscrobbler: Handshake failed, protocol error");
+                       key = @"audioscrobbler_protocol_error";
+                       comment = @"Internal protocol error";
+                       //We have a protocol error
                }
        } else if (_currentStatus == AudioscrobblerSubmittingTracksStatus) {
+               //For now we're not going to cache results, as it is less of a headache
+               [_tracks removeObjectsInArray:_submitTracks];
+               [_submitTracks removeAllObjects];
+               
                if ([responseAction isEqualToString:@"OK"]) {
+                       ITDebugLog(@"Audioscrobbler: Submission successful, clearing queue.");
+                       /*[_tracks removeObjectsInArray:_submitTracks];
+                       [_submitTracks removeAllObjects];*/
+                       if ([_tracks count] > 0) {
+                               ITDebugLog(@"Audioscrobbler: Tracks remaining in queue, submitting remaining tracks");
+                               [self performSelector:@selector(submitTracks) withObject:nil afterDelay:2];
+                       }
+                       key = @"audioscrobbler_submission_ok";
+                       comment = @"Last track submission successful";
                } else if ([responseAction isEqualToString:@"BADAUTH"]) {
+                       ITDebugLog(@"Audioscrobbler: Bad password");
+                       key = @"audioscrobbler_bad_password";
+                       comment = @"Last track submission failed - invalid password";
                        //Bad auth
                } else if (([responseAction length] > 5) && [[responseAction substringToIndex:5] isEqualToString:@"FAILED"]) {
+                       ITDebugLog(@"Audioscrobbler: Submission failed (%@)", [responseAction substringFromIndex:6]);
+                       NSLog(@"Audioscrobbler: Submission failed (%@)", [responseAction substringFromIndex:6]);
+                       key = @"audioscrobbler_submission_failed";
+                       comment = @"Last track submission failed - see console for error";
                        //Failed
                }
-               NSLog(string);
        }
        
        //Handle the final INTERVAL response
-       if (([responseAction length] > 9) && [[responseAction substringToIndex:7] isEqualToString:@"INTERVAL"]) {
-               int seconds = [[[lines objectAtIndex:[lines count] - 1] substringFromIndex:9] intValue];
+       if (([[lines objectAtIndex:[lines count] - 2] length] > 9) && [[[lines objectAtIndex:[lines count] - 2] substringToIndex:8] isEqualToString:@"INTERVAL"]) {
+               int seconds = [[[lines objectAtIndex:[lines count] - 2] substringFromIndex:9] intValue];
                ITDebugLog(@"Audioscrobbler: INTERVAL %i", seconds);
-               _delayDate = [NSDate dateWithTimeIntervalSinceNow:seconds];
+               [_delayDate release];
+               _delayDate = [[NSDate dateWithTimeIntervalSinceNow:seconds] retain];
        } else {
+               ITDebugLog(@"No interval response.");
                //We have a protocol error
        }
-       
+       [_lastStatus release];
+       _lastStatus = [NSLocalizedString(key, comment) retain];
+       [[NSNotificationCenter defaultCenter] postNotificationName:@"AudioscrobblerStatusChanged" object:nil userInfo:[NSDictionary dictionaryWithObject:_lastStatus forKey:@"StatusString"]];
        [string release];
        [_responseData release];
 }
 
--(NSURLRequest *)connection:(NSURLConnection *)connection willSendRequest:(NSURLRequest *)request redirectResponse:(NSURLResponse *)redirectResponse
-{
-       ITDebugLog(@"Audioscrobbler: Sending URL request.");
-       NSLog(@"Sending request.");
-       _responseData = [[NSMutableData alloc] init];
-       return request;
-}
-
 @end