Finished the plugin using my runScriptAndReturnResult method.
[MenuTunes.git] / MenuTunes.m
index 0b25dc9..2a584ee 100755 (executable)
@@ -4,6 +4,7 @@ Things to do:
 ¥ Optimize
 ¥ Apple Events! Apple Events! Apple Events!
 ¥ Manual and webpage
+¥ Finish up registration frontend
 */
 
 #import "MenuTunes.h"
@@ -12,6 +13,7 @@ Things to do:
 #import "StatusWindowController.h"
 
 @interface MenuTunes(Private)
+- (ITMTRemote *)loadRemote;
 - (void)updateMenu;
 - (void)rebuildUpcomingSongsMenu;
 - (void)rebuildPlaylistMenu;
@@ -20,6 +22,8 @@ Things to do:
 - (NSString *)runScriptAndReturnResult:(NSString *)script;
 - (void)timerUpdate;
 - (void)sendAEWithEventClass:(AEEventClass)eventClass andEventID:(AEEventID)eventID;
+- (void)setKeyEquivalentForCode:(short)code andModifiers:(long)modifiers
+        onItem:(NSMenuItem *)item;
 
 @end
 
@@ -30,8 +34,19 @@ Things to do:
 #pragma mark INITIALIZATION METHODS
 /*************************************************************************/
 
+- (id)init
+{
+    if ( ( self = [super init] ) ) {
+        remoteArray = [[NSMutableArray alloc] initWithCapacity:1];
+    }
+    return self;
+}
+
 - (void)applicationDidFinishLaunching:(NSNotification *)note
 {
+    currentRemote = [self loadRemote];
+    [currentRemote begin];
+    
     asComponent = OpenDefaultComponent(kOSAComponentType, kAppleScriptSubtype);
 
     [self registerDefaultsIfNeeded];
@@ -43,10 +58,12 @@ Things to do:
     {
         [self rebuildMenu];
         refreshTimer = [NSTimer scheduledTimerWithTimeInterval:3.5
-                                                    target:self
-                                                    selector:@selector(timerUpdate)
-                                                    userInfo:nil
-                                                    repeats:YES];
+                            target:self
+                            selector:@selector(timerUpdate)
+                            userInfo:nil
+                            repeats:YES];
+        
+        [[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self selector:@selector(iTunesTerminated:) name:NSWorkspaceDidTerminateApplicationNotification object:nil];
     }
     else
     {
@@ -59,13 +76,48 @@ Things to do:
     }
 
     statusItem = [[ITStatusItem alloc] initWithStatusBar:[NSStatusBar systemStatusBar]
-                                              withLength:NSVariableStatusItemLength];
+                                              withLength:NSSquareStatusItemLength];
     
     [statusItem setImage:[NSImage imageNamed:@"menu"]];
     [statusItem setAlternateImage:[NSImage imageNamed:@"selected_image"]];
     [statusItem setMenu:menu];
     // Below line of code is for creating builds for Beta Testers
-    // [statusItem setToolTip:@"This Nontransferable Beta (Built on XXX) of iThink Software's MenuTunes is Registered to: Beta Tester (betatester@somedomain.com)."];
+    // [statusItem setToolTip:@[NSString stringWithFormat:@"This Nontransferable Beta (Built on %s) of iThink Software's MenuTunes is Registered to: Beta Tester (betatester@somedomain.com).",__DATE__]];
+}
+
+- (ITMTRemote *)loadRemote
+{
+    NSString *folderPath = [[NSBundle mainBundle] builtInPlugInsPath];
+
+    if (folderPath) {
+        NSArray      *bundlePathList = [NSBundle pathsForResourcesOfType:@"remote" inDirectory:folderPath];
+        NSEnumerator *enumerator     = [bundlePathList objectEnumerator];
+        NSString     *bundlePath;
+
+        while ( (bundlePath = [enumerator nextObject]) ) {
+            NSBundle* remoteBundle = [NSBundle bundleWithPath:bundlePath];
+
+            if (remoteBundle) {
+                Class remoteClass = [remoteBundle principalClass];
+
+                if ([remoteClass conformsToProtocol:@protocol(ITMTRemote)] &&
+                    [remoteClass isKindOfClass:[NSObject class]]) {
+
+                    id remote = [remoteClass remote];
+                    [remoteArray addObject:remote];
+                }
+            }
+        }
+
+//      if ( [remoteArray count] > 0 ) {
+//          if ( [remoteArray count] > 1 ) {
+//              [remoteArray sortUsingSelector:@selector(sortAlpha:)];
+//          }
+//          [self loadModuleAccessUI]; //Comment out this line to disable remote visibility
+//      }
+    }
+    NSLog(@"%@", [remoteArray objectAtIndex:0]);
+    return [remoteArray objectAtIndex:0];
 }
 
 
@@ -176,18 +228,44 @@ Things to do:
     for (i = 0; i < [myMenu count]; i++) {
         NSString *item = [myMenu objectAtIndex:i];
         if ([item isEqualToString:@"Play/Pause"]) {
+            KeyCombo *tempCombo = [[NSUserDefaults standardUserDefaults] keyComboForKey:@"PlayPause"];
             playPauseMenuItem = [menu addItemWithTitle:@"Play"
-                                                action:@selector(playPause:)
-                                         keyEquivalent:@""];
+                                    action:@selector(playPause:)
+                                    keyEquivalent:@""];
             [playPauseMenuItem setTarget:self];
+            
+            if (tempCombo)
+            {
+                [self setKeyEquivalentForCode:[tempCombo keyCode]
+                    andModifiers:[tempCombo modifiers] onItem:playPauseMenuItem];
+                [tempCombo release];
+            }
         } else if ([item isEqualToString:@"Next Track"]) {
-            [[menu addItemWithTitle:@"Next Track"
-                             action:@selector(nextSong:)
-                      keyEquivalent:@""] setTarget:self];
+            KeyCombo *tempCombo = [[NSUserDefaults standardUserDefaults] keyComboForKey:@"NextTrack"];
+            NSMenuItem *nextTrack = [menu addItemWithTitle:@"Next Track"
+                                        action:@selector(nextSong:)
+                                        keyEquivalent:@""];
+            
+            [nextTrack setTarget:self];
+            if (tempCombo)
+            {
+                [self setKeyEquivalentForCode:[tempCombo keyCode]
+                    andModifiers:[tempCombo modifiers] onItem:nextTrack];
+                [tempCombo release];
+            }
         } else if ([item isEqualToString:@"Previous Track"]) {
-            [[menu addItemWithTitle:@"Previous Track"
-                             action:@selector(prevSong:)
-                      keyEquivalent:@""] setTarget:self];
+            KeyCombo *tempCombo = [[NSUserDefaults standardUserDefaults] keyComboForKey:@"PrevTrack"];
+            NSMenuItem *prevTrack = [menu addItemWithTitle:@"Previous Track"
+                                        action:@selector(prevSong:)
+                                        keyEquivalent:@""];
+            
+            [prevTrack setTarget:self];
+            if (tempCombo)
+            {
+                [self setKeyEquivalentForCode:[tempCombo keyCode]
+                    andModifiers:[tempCombo modifiers] onItem:prevTrack];
+                [tempCombo release];
+            }
         } else if ([item isEqualToString:@"Fast Forward"]) {
             [[menu addItemWithTitle:@"Fast Forward"
                              action:@selector(fastForward:)
@@ -274,16 +352,17 @@ Things to do:
                 if ([defaults boolForKey:@"showName"]) {
                     [menu removeItemAtIndex:index + 1];
                 }
-                if (didHaveAlbumName) {
+                if (didHaveAlbumName && [defaults boolForKey:@"showAlbum"]) {
                     [menu removeItemAtIndex:index + 1];
                 }
-                if (didHaveArtistName) {
+                if (didHaveArtistName && [defaults boolForKey:@"showArtist"]) {
                     [menu removeItemAtIndex:index + 1];
                 }
                 if ([defaults boolForKey:@"showTime"]) {
                     [menu removeItemAtIndex:index + 1];
                 }
             }
+            
             if (!isPlayingRadio) {
                 if ([defaults boolForKey:@"showTime"]) {
                     menuItem = [[NSMenuItem alloc] initWithTitle:[NSString stringWithFormat:@"  %@", [self runScriptAndReturnResult:@"return time of current track"]]
@@ -349,11 +428,11 @@ Things to do:
         }
         
         if ([defaults boolForKey:@"showArtist"]) {
-            didHaveAlbumName = (([curArtistName length] > 0) ? YES : NO);
+            didHaveArtistName = (([curArtistName length] > 0) ? YES : NO);
         }
             
         if ([defaults boolForKey:@"showAlbum"]) {
-            didHaveArtistName = (([curAlbumName length] > 0) ? YES : NO);
+            didHaveAlbumName = (([curAlbumName length] > 0) ? YES : NO);
         }
     }
 }
@@ -530,11 +609,30 @@ Things to do:
 //Called when the timer fires.
 - (void)timerUpdate
 {
-    int pid;
-    if (GetProcessPID(&iTunesPSN, &pid) == noErr) {
-        int trackPlayingIndex = [[self runScriptAndReturnResult:@"return index of current track"] intValue];
-        
-        if (trackPlayingIndex != curTrackIndex) {
+    int trackPlayingIndex = [[self runScriptAndReturnResult:@"return index of current track"] intValue];
+    
+    if (trackPlayingIndex != curTrackIndex) {
+        bool wasPlayingRadio = isPlayingRadio;
+        isPlayingRadio = [[self runScriptAndReturnResult:@"return class of current playlist"] isEqualToString:@"radio tuner playlist"];
+        if (isPlayingRadio && !wasPlayingRadio) {
+            int i;
+            for (i = 0; i < [playlistMenu numberOfItems]; i++)
+            {
+                [[playlistMenu itemAtIndex:i] setState:NSOffState];
+            }
+        }
+        if (wasPlayingRadio) {
+            NSMenuItem *temp = [[NSMenuItem alloc] initWithTitle:@"" action:NULL keyEquivalent:@""];
+            [menu insertItem:temp atIndex:trackInfoIndex + 1];
+            [temp release];
+        }
+        [self updateMenu];
+        curTrackIndex = trackPlayingIndex;
+    }
+    else
+    {
+        int playlist = [[self runScriptAndReturnResult:@"return index of current playlist"] intValue];
+        if (playlist != curPlaylistIndex) {
             bool wasPlayingRadio = isPlayingRadio;
             isPlayingRadio = [[self runScriptAndReturnResult:@"return class of current playlist"] isEqualToString:@"radio tuner playlist"];
             if (isPlayingRadio && !wasPlayingRadio) {
@@ -551,50 +649,16 @@ Things to do:
             }
             [self updateMenu];
             curTrackIndex = trackPlayingIndex;
+            curPlaylistIndex = playlist;
         }
-        else
-        {
-            int playlist = [[self runScriptAndReturnResult:@"return index of current playlist"] intValue];
-            if (playlist != curPlaylistIndex) {
-                bool wasPlayingRadio = isPlayingRadio;
-                isPlayingRadio = [[self runScriptAndReturnResult:@"return class of current playlist"] isEqualToString:@"radio tuner playlist"];
-                if (isPlayingRadio && !wasPlayingRadio) {
-                    int i;
-                    for (i = 0; i < [playlistMenu numberOfItems]; i++)
-                    {
-                        [[playlistMenu itemAtIndex:i] setState:NSOffState];
-                    }
-                }
-                if (wasPlayingRadio) {
-                    NSMenuItem *temp = [[NSMenuItem alloc] initWithTitle:@"" action:NULL keyEquivalent:@""];
-                    [menu insertItem:temp atIndex:trackInfoIndex + 1];
-                    [temp release];
-                }
-                [self updateMenu];
-                curTrackIndex = trackPlayingIndex;
-                curPlaylistIndex = playlist;
-            }
-        }
-        //Update Play/Pause menu item
-        if (playPauseMenuItem){
-            if ([[self runScriptAndReturnResult:@"return player state"] isEqualToString:@"playing"]) {
-                [playPauseMenuItem setTitle:@"Pause"];
-            } else {
-                [playPauseMenuItem setTitle:@"Play"];
-            }
+    }
+    //Update Play/Pause menu item
+    if (playPauseMenuItem){
+        if ([[self runScriptAndReturnResult:@"return player state"] isEqualToString:@"playing"]) {
+            [playPauseMenuItem setTitle:@"Pause"];
+        } else {
+            [playPauseMenuItem setTitle:@"Play"];
         }
-    } else {
-        [menu release];
-        menu = [[NSMenu alloc] initWithTitle:@""];
-        [[menu addItemWithTitle:@"Open iTunes" action:@selector(openiTunes:) keyEquivalent:@""] setTarget:self];
-        [[menu addItemWithTitle:@"Preferences" action:@selector(showPreferences:) keyEquivalent:@""] setTarget:self];
-        [[menu addItemWithTitle:@"Quit" action:@selector(quitMenuTunes:) keyEquivalent:@""] setTarget:self];
-        [statusItem setMenu:menu];
-        
-        [[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self selector:@selector(iTunesLaunched:) name:NSWorkspaceDidLaunchApplicationNotification object:nil];
-        [refreshTimer invalidate];
-        refreshTimer = nil;
-        [self clearHotKeys];
     }
 }
 
@@ -611,25 +675,47 @@ Things to do:
     [self rebuildMenu]; //Rebuild the menu since no songs will be playing
     [statusItem setMenu:menu]; //Set the menu back to the main one
     [[[NSWorkspace sharedWorkspace] notificationCenter] removeObserver:self];
+    
+    [[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self selector:@selector(iTunesTerminated:) name:NSWorkspaceDidTerminateApplicationNotification object:nil];
+}
+
+- (void)iTunesTerminated:(NSNotification *)note
+{
+    [[[NSWorkspace sharedWorkspace] notificationCenter] removeObserver:self];
+    
+    [menu release];
+    menu = [[NSMenu alloc] initWithTitle:@""];
+    [[menu addItemWithTitle:@"Open iTunes" action:@selector(openiTunes:) keyEquivalent:@""] setTarget:self];
+    [[menu addItemWithTitle:@"Preferences" action:@selector(showPreferences:) keyEquivalent:@""] setTarget:self];
+    [[menu addItemWithTitle:@"Quit" action:@selector(quitMenuTunes:) keyEquivalent:@""] setTarget:self];
+    [statusItem setMenu:menu];
+    
+    [[[NSWorkspace sharedWorkspace] notificationCenter] addObserver:self selector:@selector(iTunesLaunched:) name:NSWorkspaceDidLaunchApplicationNotification object:nil];
+    [refreshTimer invalidate];
+    refreshTimer = nil;
+    [self clearHotKeys];
 }
 
 //Return the PSN of iTunes, if it's running
 - (ProcessSerialNumber)iTunesPSN
 {
-    ProcessSerialNumber procNum;
-    procNum.highLongOfPSN = kNoProcess;
-    procNum.lowLongOfPSN = 0;
+    NSArray *apps = [[NSWorkspace sharedWorkspace] launchedApplications];
+    ProcessSerialNumber number;
+    int i;
     
-    while ( (GetNextProcess(&procNum) == noErr) ) {
-        CFStringRef procName;
-        if ( (CopyProcessName(&procNum, &procName) == noErr) ) {
-            if ([(NSString *)procName isEqualToString:@"iTunes"]) {
-                return procNum;
-            }
-            [(NSString *)procName release];
+    number.highLongOfPSN = kNoProcess;
+    
+    for (i = 0; i < [apps count]; i++)
+    {
+        NSDictionary *curApp = [apps objectAtIndex:i];
+        
+        if ([[curApp objectForKey:@"NSApplicationName"] isEqualToString:@"iTunes"])
+        {
+            number.highLongOfPSN = [[curApp objectForKey:@"NSApplicationProcessSerialNumberHigh"] intValue];
+            number.lowLongOfPSN = [[curApp objectForKey:@"NSApplicationProcessSerialNumberLow"] intValue];
         }
     }
-    return procNum;
+    return number;
 }
 
 //Send an AppleEvent with a given event ID
@@ -646,9 +732,13 @@ andEventID:(AEEventID)eventID
     AEDisposeDesc(&reply);
 }
 
+//
 //
 // Selectors - called from status item menu
 //
+//
+
+// Plugin dependent selectors
 
 - (void)playTrack:(id)sender
 {
@@ -695,12 +785,12 @@ isEqualToString:@"rewinding"]) {
 
 - (void)nextSong:(id)sender
 {
-    [self sendAEWithEventClass:'hook' andEventID:'Next'];
+    [currentRemote goToNextSong];
 }
 
 - (void)prevSong:(id)sender
 {
-    [self sendAEWithEventClass:'hook' andEventID:'Prev'];
+    [currentRemote goToPreviousSong];
 }
 
 - (void)fastForward:(id)sender
@@ -713,6 +803,8 @@ isEqualToString:@"rewinding"]) {
     [self sendAEWithEventClass:'hook' andEventID:'Rwnd'];
 }
 
+// Plugin independent selectors
+
 - (void)quitMenuTunes:(id)sender
 {
     [NSApp terminate:self];
@@ -753,7 +845,6 @@ isEqualToString:@"rewinding"]) {
     if (!statusController && [trackName length]) {
         NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
         NSString *stringToShow = @"";
-        int lines = 1;
         
         if ([defaults boolForKey:@"showName"]) {
             if ([defaults boolForKey:@"showArtist"]) {
@@ -762,10 +853,6 @@ isEqualToString:@"rewinding"]) {
             }
             stringToShow = [stringToShow stringByAppendingString:trackName];
             stringToShow = [stringToShow stringByAppendingString:@"\n"];
-            if ([trackName length] > 38) {
-                lines++;
-            }
-            lines++;
         }
         
         if ([defaults boolForKey:@"showAlbum"]) {
@@ -773,7 +860,6 @@ isEqualToString:@"rewinding"]) {
             if ([trackAlbum length]) {
                 stringToShow = [stringToShow stringByAppendingString:trackAlbum];
                 stringToShow = [stringToShow stringByAppendingString:@"\n"];
-                lines++;
             }
         }
         
@@ -781,7 +867,6 @@ isEqualToString:@"rewinding"]) {
             NSString *trackTime = [self runScriptAndReturnResult:@"return time of current track"];
             if ([trackTime length]) {
                 stringToShow = [NSString stringWithFormat:@"%@Total Time: %@\n", stringToShow, trackTime];
-                lines++;
             }
         }
         
@@ -798,7 +883,7 @@ isEqualToString:@"rewinding"]) {
         }
         
         statusController = [[StatusWindowController alloc] init];
-        [statusController setTrackInfo:stringToShow lines:lines];
+        [statusController setTrackInfo:stringToShow];
         [NSTimer scheduledTimerWithTimeInterval:3.0
                                     target:self
                                     selector:@selector(fadeAndCloseStatusWindow)
@@ -827,12 +912,12 @@ isEqualToString:@"rewinding"]) {
                     songs = [songs stringByAppendingString:@"\n"];
                 }
             }
-            [statusController setUpcomingSongs:songs numSongs:numSongsInAdvance];
+            [statusController setUpcomingSongs:songs];
             [NSTimer scheduledTimerWithTimeInterval:3.0
-                                             target:self
-                                           selector:@selector(fadeAndCloseStatusWindow)
-                                           userInfo:nil
-                                            repeats:NO];
+                        target:self
+                        selector:@selector(fadeAndCloseStatusWindow)
+                        userInfo:nil
+                        repeats:NO];
         }
     }
 }
@@ -844,6 +929,168 @@ isEqualToString:@"rewinding"]) {
     statusController = nil;
 }
 
+- (void)setKeyEquivalentForCode:(short)code andModifiers:(long)modifiers
+        onItem:(NSMenuItem *)item
+{
+    unichar charcode = 'a';
+    int i;
+    long cocoaModifiers = 0;
+    static long carbonToCocoa[6][2] = 
+    {
+        { cmdKey, NSCommandKeyMask },
+        { optionKey, NSAlternateKeyMask },
+        { controlKey, NSControlKeyMask },
+        { shiftKey, NSShiftKeyMask },
+    };
+    
+    for (i = 0; i < 6; i++)
+    {
+        if (modifiers & carbonToCocoa[i][0])
+        {
+            cocoaModifiers += carbonToCocoa[i][1];
+        }
+    }
+    [item setKeyEquivalentModifierMask:cocoaModifiers];
+    
+    //Missing key combos for some keys. Must find them later.
+    switch (code)
+    {
+        case 36:
+        break;
+        
+        case 48:
+        break;
+        
+        case 49:
+        break;
+        
+        case 51:
+            charcode = NSDeleteFunctionKey;
+        break;        
+        case 53:
+        break;
+                
+        case 71:
+        break;
+        
+        case 76:
+        break;
+        
+        case 96:
+            charcode = NSF5FunctionKey;
+        break;
+        
+        case 97:
+            charcode = NSF6FunctionKey;
+        break;
+        
+        case 98:
+            charcode = NSF7FunctionKey;
+        break;
+        
+        case 99:
+            charcode = NSF3FunctionKey;
+        break;
+        
+        case 100:
+            charcode = NSF8FunctionKey;
+        break;
+        
+        case 101:
+            charcode = NSF9FunctionKey;
+        break;
+        
+        case 103:
+            charcode = NSF11FunctionKey;
+        break;
+        
+        case 105:
+            charcode = NSF3FunctionKey;
+        break;
+        
+        case 107:
+            charcode = NSF14FunctionKey;
+        break;
+        
+        case 109:
+            charcode = NSF10FunctionKey;
+        break;
+        
+        case 111:
+            charcode = NSF12FunctionKey;
+        break;
+        
+        case 113:
+            charcode = NSF13FunctionKey;
+        break;
+        
+        case 114:
+            charcode = NSInsertFunctionKey;
+        break;
+        
+        case 115:
+        break;
+        
+        case 116:
+            charcode = NSPageUpFunctionKey;
+        break;
+        
+        case 117:
+            charcode = NSDeleteFunctionKey;
+        break;
+        
+        case 118:
+            charcode = NSF4FunctionKey;
+        break;
+        
+        case 119:
+            charcode = NSEndFunctionKey;
+        break;
+        
+        case 120:
+            charcode = NSF2FunctionKey;
+        break;
+        
+        case 121:
+            charcode = NSPageDownFunctionKey;
+        break;
+        
+        case 122:
+            charcode = NSF1FunctionKey;
+        break;
+        
+        case 123:
+            charcode = NSLeftArrowFunctionKey;
+        break;
+        
+        case 124:
+            charcode = NSRightArrowFunctionKey;
+        break;
+        
+        case 125:
+            charcode = NSDownArrowFunctionKey;
+        break;
+        
+        case 126:
+            charcode = NSUpArrowFunctionKey;
+        break;
+    }
+    
+    if (charcode == 'a') {
+        unsigned long state;
+        long keyTrans;
+        char charCode;
+        Ptr kchr;
+        state = 0;
+        kchr = (Ptr) GetScriptVariable(smCurrentScript, smKCHRCache);
+        keyTrans = KeyTranslate(kchr, code, &state);
+        charCode = keyTrans;
+        [item setKeyEquivalent:[NSString stringWithCString:&charCode length:1]];
+    } else {
+        [item setKeyEquivalent:[NSString stringWithCharacters:&charcode length:1]];
+    }
+}
+
 /*************************************************************************/
 #pragma mark -
 #pragma mark NSApplication DELEGATE METHODS
@@ -874,5 +1121,4 @@ isEqualToString:@"rewinding"]) {
     [super dealloc];
 }
 
-
-@end
+@end
\ No newline at end of file