Source/ESEventSoundAlertDetailPane.m

   1 /*
   2  * Adium is the legal property of its developers, whose names are listed in the copyright file included
   3  * with this source distribution.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
   6  * General Public License as published by the Free Software Foundation; either version 2 of the License,
   7  * or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  10  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
  11  * Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with this program; if not,
  14  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  15  */
  16
  17 #import "AIEventSoundsPlugin.h"
  18 #import "AIPreferenceController.h"
  19 #import "AISoundController.h"
  20 #import "ESEventSoundAlertDetailPane.h"
  21 #import <AIUtilities/AIMenuAdditions.h>
  22 #import <AIUtilities/AIStringAdditions.h>
  23 #import <AIUtilities/ESImageAdditions.h>
  24 #import <Adium/AILocalizationTextField.h>
  25
  26 #define PLAY_A_SOUND                    AILocalizedString(@"Play a sound",nil)
  27 #define KEY_DEFAULT_SOUND_DICT  @"Default Sound Dict"
  28
  29 @interface ESEventSoundAlertDetailPane (PRIVATE)
  30 - (NSMenu *)soundListMenu;
  31 - (void)addSound:(NSString *)soundPath toMenu:(NSMenu *)soundMenu;
  32 @end
  33
  34 /*!
  35  * @class ESEventSoundAlertDetailPane
  36  * @brief Details pane for the Play Sound action
  37  */
  38 @implementation ESEventSoundAlertDetailPane
  39
  40 /*!
  41  * @brief Nib name
  42  */
  43 - (NSString *)nibName{
  44     return(@"EventSoundContactAlert");
  45 }
  46
  47 /*!
  48  * @brief Configure the detail view
  49  */
  50 - (void)viewDidLoad
  51 {
  52         [label_sound setLocalizedString:AILocalizedString(@"Sound:",nil)];
  53
  54         /* Loading and using the real file icons is slow, and all the sound files should have the same icons anyway.  So
  55          * we can cheat and load a sound icon from our bundle here (for all the menu items) for a nice speed boost. */
  56         if(!soundFileIcon) soundFileIcon = [[NSImage imageNamed:@"SoundFileIcon" forClass:[self class]] retain];
  57
  58         //Prepare our sound menu
  59     [popUp_actionDetails setMenu:[self soundListMenu]];
  60
  61         [super viewDidLoad];
  62 }
  63
  64 /*!
  65  * @brief View will close
  66  */
  67 - (void)viewWillClose
  68 {
  69         [soundFileIcon release]; soundFileIcon = nil;
  70         [super viewWillClose];
  71 }
  72
  73 /*!
  74  * @brief Configure for the action
  75  */
  76 - (void)configureForActionDetails:(NSDictionary *)inDetails listObject:(AIListObject *)inObject
  77 {
  78         NSString        *selectedSound;
  79         int                     soundIndex;
  80
  81         if(!inDetails) inDetails = [[adium preferenceController] preferenceForKey:KEY_DEFAULT_SOUND_DICT
  82                                                                                                                                                 group:PREF_GROUP_SOUNDS];
  83
  84         //If the user has a custom sound selected, we need to create an entry in the menu for it
  85         selectedSound = [inDetails objectForKey:KEY_ALERT_SOUND_PATH];
  86         if (selectedSound) {
  87                 if([[popUp_actionDetails menu] indexOfItemWithRepresentedObject:selectedSound] == -1){
  88                         [self addSound:selectedSound toMenu:[popUp_actionDetails menu]];
  89                 }
  90
  91                 //Set the menu to its previous setting if the stored event matches
  92                 soundIndex = [popUp_actionDetails indexOfItemWithRepresentedObject:[inDetails objectForKey:KEY_ALERT_SOUND_PATH]];
  93                 if(soundIndex >= 0 && soundIndex < [popUp_actionDetails numberOfItems]){
  94                         [popUp_actionDetails selectItemAtIndex:soundIndex];
  95                 }
  96
  97         } else {
  98                 [popUp_actionDetails selectItemAtIndex:-1];
  99         }
 100 }
 101
 102 /*!
 103  * @brief Return our current configuration
 104  */
 105 - (NSDictionary *)actionDetails
 106 {
 107         NSString                *soundPath = [[popUp_actionDetails selectedItem] representedObject];
 108         NSDictionary    *actionDetails = nil;
 109
 110         if(soundPath && [soundPath length]){
 111                 actionDetails = [NSDictionary dictionaryWithObject:soundPath forKey:KEY_ALERT_SOUND_PATH];
 112         }
 113
 114         //Save the preferred settings for future use as defaults
 115         [[adium preferenceController] setPreference:actionDetails
 116                                                                                  forKey:KEY_DEFAULT_SOUND_DICT
 117                                                                                   group:PREF_GROUP_SOUNDS];
 118
 119         return actionDetails;
 120 }
 121
 122
 123 //Sound Menu -----------------------------------------------------------------------------------------------------------
 124 #pragma mark Sound Menu
 125 /*!
 126  * @brief Builds and returns a sound list menu
 127  *
 128  * The menu is organized by sound set.
 129  */
 130 - (NSMenu *)soundListMenu
 131 {
 132         NSMenu                  *soundMenu = [[NSMenu alloc] init];
 133         NSEnumerator    *enumerator;
 134         NSDictionary    *soundSetDict;
 135         NSMenuItem              *menuItem;
 136
 137         //Add all soundsets to our menu
 138         enumerator = [[[adium soundController] soundSetArray] objectEnumerator];
 139         while((soundSetDict = [enumerator nextObject])){
 140                 NSEnumerator    *soundEnumerator;
 141                 NSString        *soundPath;
 142                 NSArray         *soundSetContents = [soundSetDict objectForKey:KEY_SOUND_SET_CONTENTS];
 143
 144                 if(soundSetContents && [soundSetContents count]){
 145                         NSMenu  *soundsetMenu = [[NSMenu allocWithZone:[NSMenu menuZone]] init];
 146
 147                         //Add an item for the set
 148                         menuItem = [[[NSMenuItem allocWithZone:[NSMenu menuZone]] initWithTitle:[[[soundSetDict objectForKey:KEY_SOUND_SET] lastPathComponent] stringByDeletingPathExtension]
 149                                                                                                                                                          target:nil
 150                                                                                                                                                          action:nil
 151                                                                                                                                           keyEquivalent:@""] autorelease];
 152
 153                         //Add an item for each sound
 154                         soundEnumerator = [soundSetContents objectEnumerator];
 155                         while((soundPath = [soundEnumerator nextObject])){
 156                                 [self addSound:soundPath toMenu:soundsetMenu];
 157                         }
 158
 159                         [menuItem setSubmenu:soundsetMenu];
 160                         [soundsetMenu release];
 161
 162                         [soundMenu addItem:menuItem];
 163                 }
 164         }
 165
 166         //Add a divider between the sets and Other...
 167         [soundMenu addItem:[NSMenuItem separatorItem]];
 168
 169         //Add the "Other..." item
 170         menuItem = [[[NSMenuItem allocWithZone:[NSMenu menuZone]] initWithTitle:OTHER_ELLIPSIS
 171                                                                                                                                          target:self
 172                                                                                                                                          action:@selector(selectSound:)
 173                                                                                                                           keyEquivalent:@""] autorelease];
 174         [soundMenu addItem:menuItem];
 175         [soundMenu setAutoenablesItems:NO];
 176
 177     return([soundMenu autorelease]);
 178 }
 179
 180 /*!
 181  * @brief Add a sound menu item to a menu
 182  */
 183 - (void)addSound:(NSString *)soundPath toMenu:(NSMenu *)soundMenu
 184 {
 185         NSString        *soundTitle = [[soundPath lastPathComponent] stringByDeletingPathExtension];
 186         NSMenuItem      *menuItem = [[[NSMenuItem allocWithZone:[NSMenu menuZone]] initWithTitle:soundTitle
 187                                                                                                                                                                   target:self
 188                                                                                                                                                                   action:@selector(selectSound:)
 189                                                                                                                                                    keyEquivalent:@""] autorelease];
 190
 191         [menuItem setRepresentedObject:[soundPath stringByCollapsingBundlePath]];
 192         [menuItem setImage:soundFileIcon];
 193         [soundMenu addItem:menuItem];
 194 }
 195
 196 /*!
 197  * @brief Add a soundPath to the menu root if it is not yet present, then select it
 198  *
 199  * @param The soundPath, which should have a collapsed bundle path (to match menuItem represented objects)
 200  */
 201 - (void)addAndSelectSoundPath:(NSString *)soundPath
 202 {
 203         NSMenu  *rootMenu = [popUp_actionDetails menu];
 204         int             menuIndex;
 205
 206         //Check for it currently being present in the root menu
 207         menuIndex = [popUp_actionDetails indexOfItemWithRepresentedObject:soundPath];
 208         if (menuIndex == -1) {
 209                 //Add it if it wasn't found
 210                 [self addSound:soundPath toMenu:rootMenu];
 211                 menuIndex = [popUp_actionDetails indexOfItemWithRepresentedObject:soundPath];
 212         }
 213
 214         if (menuIndex != -1) {
 215                 [popUp_actionDetails selectItemAtIndex:menuIndex];
 216         }
 217 }
 218
 219 /*!
 220  * @brief A sound was selected from a sound popUp menu
 221  *
 222  * Update our header and play the sound.  If "Other..." is selected, allow selection of a file.
 223  */
 224 - (IBAction)selectSound:(id)sender
 225 {
 226     NSString    *soundPath = [sender representedObject];
 227
 228     if(soundPath != nil && [soundPath length] != 0){
 229         [[adium soundController] playSoundAtPath:[soundPath stringByExpandingBundlePath]]; //Play the sound
 230
 231                 //Update the menu and and the selection
 232                 [self addAndSelectSoundPath:soundPath];
 233
 234                 [self detailsForHeaderChanged];
 235     }else{ //selected "Other..."
 236         NSOpenPanel *openPanel = [NSOpenPanel openPanel];
 237
 238         [openPanel
 239             beginSheetForDirectory:nil
 240                               file:nil
 241                              types:[NSSound soundUnfilteredFileTypes] //allow all the sounds NSSound understands
 242                     modalForWindow:[view window]
 243                      modalDelegate:self
 244                     didEndSelector:@selector(concludeOtherPanel:returnCode:contextInfo:)
 245                        contextInfo:nil];
 246
 247     }
 248 }
 249
 250 /*!
 251  * @brief Finish up the Other... panel
 252  *
 253  * Play the selected sound and update the menu.
 254  */
 255 - (void)concludeOtherPanel:(NSOpenPanel *)panel returnCode:(int)returnCode contextInfo:(void *)contextInfo
 256 {
 257     if(returnCode == NSOKButton){
 258         NSString *soundPath = [[panel filenames] objectAtIndex:0];
 259
 260         [[adium soundController] playSoundAtPath:soundPath]; //Play the sound
 261
 262         //Update the menu and and the selection
 263                 [self addAndSelectSoundPath:soundPath];
 264
 265                 [self detailsForHeaderChanged];
 266     }
 267 }
 268
 269 @end