diff options
Diffstat (limited to 'Source/SPConnectionController.m')
| -rw-r--r-- | Source/SPConnectionController.m | 1534 |
1 files changed, 849 insertions, 685 deletions
diff --git a/Source/SPConnectionController.m b/Source/SPConnectionController.m index aaff9687..b7f42654 100644 --- a/Source/SPConnectionController.m +++ b/Source/SPConnectionController.m @@ -32,17 +32,32 @@ #import "SPAlertSheets.h" #import "SPKeychain.h" #import "SPSSHTunnel.h" -#import "SPFavoriteNode.h" #import "SPTableTextFieldCell.h" +#import "SPFavoritesController.h" +#import "SPFavoriteNode.h" + +// Constants +static const NSString *SPRemoveNode = @"RemoveNode"; +static const NSString *SPImportFavorites = @"ImportFavorites"; +static const NSString *SPExportFavorites = @"ExportFavorites"; +static const NSString *SPExportFavoritesFilename = @"SequelProFavorites.plist"; @interface SPConnectionController (PrivateAPI) +- (BOOL)_checkHost; - (void)_sortFavorites; -- (void)_buildFavoritesTree; +- (void)_favoriteTypeDidChange; +- (void)_reloadFavoritesViewData; - (void)_restoreConnectionInterface; - (void)_mySQLConnectionEstablished; +- (void)_selectNode:(SPTreeNode *)node; - (void)_initiateMySQLConnectionInBackground; +- (NSNumber *)_createNewFavoriteID; +- (SPTreeNode *)_favoriteNodeForFavoriteID:(NSInteger)favoriteID; + +- (void)_updateFavoritePasswordsFromField:(NSControl *)control; + @end @implementation SPConnectionController @@ -83,124 +98,141 @@ * Initialise the connection controller, linking it to the * parent document and setting up the parent window. */ -- (id) initWithDocument:(SPDatabaseDocument *)theTableDocument +- (id)initWithDocument:(SPDatabaseDocument *)document { if (self = [super init]) { - tableDocument = theTableDocument; - databaseConnectionSuperview = [tableDocument databaseView]; - databaseConnectionView = [tableDocument valueForKey:@"contentViewSplitter"]; + + // Weak reference + dbDocument = document; + + databaseConnectionSuperview = [dbDocument databaseView]; + databaseConnectionView = [dbDocument valueForKey:@"contentViewSplitter"]; + + // Keychain references connectionKeychainItemName = nil; connectionKeychainItemAccount = nil; connectionSSHKeychainItemName = nil; connectionSSHKeychainItemAccount = nil; - mySQLConnection = nil; + sshTunnel = nil; - cancellingConnection = NO; + mySQLConnection = nil; isConnecting = NO; + cancellingConnection = NO; mySQLConnectionCancelled = NO; - favoritesPBoardType = @"FavoritesPBoardType"; - + + favoriteNameFieldWasTouched = YES; + // Load the connection nib, keeping references to the top-level objects for later release nibObjectsToRelease = [[NSMutableArray alloc] init]; NSArray *connectionViewTopLevelObjects = nil; NSNib *nibLoader = [[NSNib alloc] initWithNibNamed:@"ConnectionView" bundle:[NSBundle mainBundle]]; + [nibLoader instantiateNibWithOwner:self topLevelObjects:&connectionViewTopLevelObjects]; [nibObjectsToRelease addObjectsFromArray:connectionViewTopLevelObjects]; [nibLoader release]; - + // Hide the main view and position and display the connection view [databaseConnectionView setHidden:YES]; [connectionView setFrame:[databaseConnectionView frame]]; - [databaseConnectionSuperview addSubview:connectionView]; - [connectionSplitView setPosition:[[tableDocument valueForKey:@"dbTablesTableView"] frame].size.width-6 ofDividerAtIndex:0]; + [databaseConnectionSuperview addSubview:connectionView]; + [connectionSplitView setPosition:[[dbDocument valueForKey:@"dbTablesTableView"] frame].size.width-6 ofDividerAtIndex:0]; [connectionSplitViewButtonBar setSplitViewDelegate:self]; + [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(scrollViewFrameChanged:) name:NSViewFrameDidChangeNotification object:nil]; - + + // Generic folder image for use in the outline view's groups + folderImage = [[[NSWorkspace sharedWorkspace] iconForFileType:NSFileTypeForHFSTypeCode(kGenericFolderIcon)] retain]; + + [folderImage setSize:NSMakeSize(16, 16)]; + // Set up a keychain instance and preferences reference, and create the initial favorites list keychain = [[SPKeychain alloc] init]; prefs = [[NSUserDefaults standardUserDefaults] retain]; - - favorites = nil; - - // Load favorites - [self updateFavorites]; - - // Expand the favorites heading - [favoritesTable expandItem:[[favoritesRoot nodeChildren] objectAtIndex:0]]; - - // Register an observer for changes within the favorites - [prefs addObserver:self forKeyPath:SPFavorites options:NSKeyValueObservingOptionNew context:NULL]; - - // Set sort items - currentSortItem = [prefs integerForKey:SPFavoritesSortedBy]; - reverseFavoritesSort = [prefs boolForKey:SPFavoritesSortedInReverse]; - - // Register double click for the favorites view (double click favorite to connect) - [favoritesTable setTarget:self]; - [favoritesTable registerForDraggedTypes:[NSArray arrayWithObject:favoritesPBoardType]]; - [favoritesTable setDraggingSourceOperationMask:NSDragOperationMove forLocal:YES]; - - // Sort the favourites to match prefs and select the appropriate row - if a valid sort option is selected - if (currentSortItem > -1) [self _sortFavorites]; - - NSInteger tableRow = [prefs integerForKey:[prefs boolForKey:SPSelectLastFavoriteUsed] ? SPLastFavoriteIndex : SPDefaultFavorite]; - - if (tableRow < [favorites count]) { - previousType = [[[favorites objectAtIndex:tableRow] objectForKey:SPFavoriteTypeKey] integerValue]; - [favoritesTable selectRowIndexes:[NSIndexSet indexSetWithIndex:(tableRow + 1)] byExtendingSelection:NO]; - [self resizeTabViewToConnectionType:[[[favorites objectAtIndex:tableRow] objectForKey:SPFavoriteTypeKey] integerValue] animating:NO]; - [favoritesTable scrollRowToVisible:[favoritesTable selectedRow]]; - } + + // Create a reference to the favorites controller, forcing the data to be loaded from disk and the + // tree constructor. + favoritesController = [SPFavoritesController sharedFavoritesController]; + + // Tree reference + favoritesRoot = [favoritesController favoritesTree]; + + // Update the UI + [self _reloadFavoritesViewData]; + + // Set sort items + currentSortItem = [prefs integerForKey:SPFavoritesSortedBy]; + reverseFavoritesSort = [prefs boolForKey:SPFavoritesSortedInReverse]; + + // Register double click action for the favorites outline view (double click favorite to connect) + [favoritesOutlineView setTarget:self]; + [favoritesOutlineView setDoubleAction:@selector(nodeDoubleClicked:)]; + [favoritesOutlineView registerForDraggedTypes:[NSArray arrayWithObject:SPFavoritesPasteboardDragType]]; + [favoritesOutlineView setDraggingSourceOperationMask:NSDragOperationMove forLocal:YES]; + + // Registered to be notified of changes to connection information + [self addObserver:self forKeyPath:SPFavoriteNameKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteHostKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteUserKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteDatabaseKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSocketKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoritePortKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteUseSSLKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSHHostKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSHUserKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSHPortKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSHKeyLocationEnabledKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSHKeyLocationKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSLKeyFileLocationEnabledKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSLKeyFileLocationKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSLCertificateFileLocationEnabledKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSLCertificateFileLocationKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSLCACertFileLocationEnabledKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + [self addObserver:self forKeyPath:SPFavoriteSSLCACertFileLocationKey options:(NSKeyValueObservingOptionOld | NSKeyValueObservingOptionNew) context:NULL]; + + SPTreeNode *favorite = [self _favoriteNodeForFavoriteID:[prefs integerForKey:([prefs boolForKey:SPSelectLastFavoriteUsed]) ? SPLastFavoriteID : SPDefaultFavorite]]; + + if (favorite) { + + NSNumber *typeNumber = [[[favorite representedObject] nodeFavorite] objectForKey:SPFavoriteTypeKey]; + + previousType = (typeNumber) ? [typeNumber integerValue] : SPTCPIPConnection; + + [self _selectNode:favorite]; + + [self resizeTabViewToConnectionType:[[[[favorite representedObject] nodeFavorite] objectForKey:SPFavoriteTypeKey] integerValue] animating:NO]; + + [favoritesOutlineView scrollRowToVisible:[favoritesOutlineView selectedRow]]; + } else { previousType = SPTCPIPConnection; + [self resizeTabViewToConnectionType:SPTCPIPConnection animating:NO]; } } - + return self; } -- (void) dealloc -{ - [prefs removeObserver:self forKeyPath:SPFavorites]; - [[NSNotificationCenter defaultCenter] removeObserver:self]; - [keychain release]; - [prefs release]; - - for (id retainedObject in nibObjectsToRelease) [retainedObject release]; - [nibObjectsToRelease release]; - - if (favorites) [favorites release]; - if (mySQLConnection) [mySQLConnection release]; - if (sshTunnel) [sshTunnel setConnectionStateChangeSelector:nil delegate:nil], [sshTunnel disconnect], [sshTunnel release]; - if (connectionKeychainItemName) [connectionKeychainItemName release]; - if (connectionKeychainItemAccount) [connectionKeychainItemAccount release]; - if (connectionSSHKeychainItemName) [connectionSSHKeychainItemName release]; - if (connectionSSHKeychainItemAccount) [connectionSSHKeychainItemAccount release]; - - [super dealloc]; -} - #pragma mark - #pragma mark Connection processes -/* +/** * Starts the connection process; invoked when user hits the connect button * or double-clicks on a favourite. * Error-checks fields as required, and triggers connection of MySQL or any * connection proxies in use. */ - (IBAction)initiateConnection:(id)sender -{ +{ // Ensure that host is not empty if this is a TCP/IP or SSH connection if (([self type] == SPTCPIPConnection || [self type] == SPSSHTunnelConnection) && ![[self host] length]) { - SPBeginAlertSheet(NSLocalizedString(@"Insufficient connection details", @"insufficient details message"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [tableDocument parentWindow], self, nil, nil, NSLocalizedString(@"Insufficient details provided to establish a connection. Please enter at least the hostname.", @"insufficient details informative message")); + SPBeginAlertSheet(NSLocalizedString(@"Insufficient connection details", @"insufficient details message"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [dbDocument parentWindow], self, nil, nil, NSLocalizedString(@"Insufficient details provided to establish a connection. Please enter at least the hostname.", @"insufficient details informative message")); return; } - + // If SSH is enabled, ensure that the SSH host is not nil if ([self type] == SPSSHTunnelConnection && ![[self sshHost] length]) { - SPBeginAlertSheet(NSLocalizedString(@"Insufficient connection details", @"insufficient details message"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [tableDocument parentWindow], self, nil, nil, NSLocalizedString(@"Insufficient details provided to establish a connection. Please enter the hostname for the SSH Tunnel, or disable the SSH Tunnel.", @"insufficient SSH tunnel details informative message")); + SPBeginAlertSheet(NSLocalizedString(@"Insufficient connection details", @"insufficient details message"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [dbDocument parentWindow], self, nil, nil, NSLocalizedString(@"Insufficient details provided to establish a connection. Please enter the hostname for the SSH Tunnel, or disable the SSH Tunnel.", @"insufficient SSH tunnel details informative message")); return; } @@ -208,13 +240,13 @@ if ([self type] == SPSSHTunnelConnection && sshKeyLocationEnabled && sshKeyLocation) { if (![[NSFileManager defaultManager] fileExistsAtPath:[sshKeyLocation stringByExpandingTildeInPath]]) { [self setSshKeyLocationEnabled:NSOffState]; - SPBeginAlertSheet(NSLocalizedString(@"SSH Key not found", @"SSH key check error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [tableDocument parentWindow], self, nil, nil, NSLocalizedString(@"A SSH key location was specified, but no file was found in the specified location. Please re-select the key and try again.", @"SSH key not found message")); + SPBeginAlertSheet(NSLocalizedString(@"SSH Key not found", @"SSH key check error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [dbDocument parentWindow], self, nil, nil, NSLocalizedString(@"A SSH key location was specified, but no file was found in the specified location. Please re-select the key and try again.", @"SSH key not found message")); return; } } // Ensure that a socket connection is not inadvertently used - if (![self checkHost]) return; + if (![self _checkHost]) return; // If SSL keys have been supplied, verify they exist if (([self type] == SPTCPIPConnection || [self type] == SPSocketConnection) && [self useSSL]) { @@ -223,7 +255,7 @@ { [self setSslKeyFileLocationEnabled:NSOffState]; [self setSslKeyFileLocation:nil]; - SPBeginAlertSheet(NSLocalizedString(@"SSL Key File not found", @"SSL key file check error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [tableDocument parentWindow], self, nil, nil, NSLocalizedString(@"A SSL key file location was specified, but no file was found in the specified location. Please re-select the key file and try again.", @"SSL key file not found message")); + SPBeginAlertSheet(NSLocalizedString(@"SSL Key File not found", @"SSL key file check error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [dbDocument parentWindow], self, nil, nil, NSLocalizedString(@"A SSL key file location was specified, but no file was found in the specified location. Please re-select the key file and try again.", @"SSL key file not found message")); return; } if (sslCertificateFileLocationEnabled && sslCertificateFileLocation @@ -231,7 +263,7 @@ { [self setSslCertificateFileLocationEnabled:NSOffState]; [self setSslCertificateFileLocation:nil]; - SPBeginAlertSheet(NSLocalizedString(@"SSL Certificate File not found", @"SSL certificate file check error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [tableDocument parentWindow], self, nil, nil, NSLocalizedString(@"A SSL certificate location was specified, but no file was found in the specified location. Please re-select the certificate and try again.", @"SSL certificate file not found message")); + SPBeginAlertSheet(NSLocalizedString(@"SSL Certificate File not found", @"SSL certificate file check error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [dbDocument parentWindow], self, nil, nil, NSLocalizedString(@"A SSL certificate location was specified, but no file was found in the specified location. Please re-select the certificate and try again.", @"SSL certificate file not found message")); return; } if (sslCACertFileLocationEnabled && sslCACertFileLocation @@ -239,7 +271,7 @@ { [self setSslCACertFileLocationEnabled:NSOffState]; [self setSslCACertFileLocation:nil]; - SPBeginAlertSheet(NSLocalizedString(@"SSL Certificate Authority File not found", @"SSL certificate authority file check error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [tableDocument parentWindow], self, nil, nil, NSLocalizedString(@"A SSL Certificate Authority certificate location was specified, but no file was found in the specified location. Please re-select the Certificate Authority certificate and try again.", @"SSL CA certificate file not found message")); + SPBeginAlertSheet(NSLocalizedString(@"SSL Certificate Authority File not found", @"SSL certificate authority file check error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [dbDocument parentWindow], self, nil, nil, NSLocalizedString(@"A SSL Certificate Authority certificate location was specified, but no file was found in the specified location. Please re-select the Certificate Authority certificate and try again.", @"SSL CA certificate file not found message")); return; } } @@ -247,7 +279,7 @@ // Basic details have validated - start the connection process animating isConnecting = YES; cancellingConnection = NO; - + [addToFavoritesButton setHidden:YES]; [addToFavoritesButton display]; [helpButton setHidden:YES]; @@ -258,9 +290,9 @@ [progressIndicator display]; [progressIndicatorText setHidden:NO]; [progressIndicatorText display]; - + // Start the current tab's progress indicator - [tableDocument setIsProcessing:YES]; + [dbDocument setIsProcessing:YES]; // If the password(s) are marked as having been originally sourced from a keychain, check whether they // have been changed or not; if not, leave the mark in place and remove the password from the field @@ -271,11 +303,13 @@ [[standardPasswordField undoManager] removeAllActionsWithTarget:standardPasswordField]; [[socketPasswordField undoManager] removeAllActionsWithTarget:socketPasswordField]; [[sshPasswordField undoManager] removeAllActionsWithTarget:sshPasswordField]; - } else { + } + else { [connectionKeychainItemName release], connectionKeychainItemName = nil; [connectionKeychainItemAccount release], connectionKeychainItemAccount = nil; } } + if (connectionSSHKeychainItemName) { if ([[keychain getPasswordForName:connectionSSHKeychainItemName account:connectionSSHKeychainItemAccount] isEqualToString:[self sshPassword]]) { [self setSshPassword:[[NSString string] stringByPaddingToLength:[[self sshPassword] length] withString:@"sp" startingAtIndex:0]]; @@ -285,22 +319,22 @@ [connectionSSHKeychainItemAccount release], connectionSSHKeychainItemAccount = nil; } } - + // Inform the delegate that we are starting the connection process if (delegate && [delegate respondsToSelector:@selector(connectionControllerInitiatingConnection:)]) { [delegate connectionControllerInitiatingConnection:self]; } - + // Trim whitespace and newlines from the host field before attempting to connect [self setHost:[[self host] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]]; - + // Initiate the SSH connection process for tunnels if ([self type] == SPSSHTunnelConnection) { [self performSelector:@selector(initiateSSHTunnelConnection) withObject:nil afterDelay:0.0]; return; } - - // ...or start the MySQL connection process directly + + // ...or start the MySQL connection process directly [self performSelector:@selector(initiateMySQLConnection) withObject:nil afterDelay:0.0]; } @@ -314,229 +348,39 @@ - (IBAction)cancelMySQLConnection:(id)sender { [connectButton setEnabled:NO]; - + [progressIndicatorText setStringValue:NSLocalizedString(@"Cancelling...", @"cancelling task status message")]; [progressIndicatorText display]; - + mySQLConnectionCancelled = YES; } -/* - * Initiate the SSH connection process. - * This should only be called as part of initiateConnection:, and will indirectly - * call initiateMySQLConnection if it's successful. - */ -- (void)initiateSSHTunnelConnection -{ - [progressIndicatorText setStringValue:NSLocalizedString(@"SSH connecting...", @"SSH connecting very short status message")]; - [progressIndicatorText display]; - - // Trim whitespace and newlines from the SSH host field before attempting to connect - [self setSshHost:[[self sshHost] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]]]; - - // Set up the tunnel details - sshTunnel = [[SPSSHTunnel alloc] initToHost:[self sshHost] port:[[self sshPort] integerValue] login:[self sshUser] tunnellingToPort:([[self port] length]?[[self port] integerValue]:3306) onHost:[self host]]; - [sshTunnel setParentWindow:[tableDocument parentWindow]]; - - // Add keychain or plaintext password as appropriate - note the checks in initiateConnection. - if (connectionSSHKeychainItemName) { - [sshTunnel setPasswordKeychainName:connectionSSHKeychainItemName account:connectionSSHKeychainItemAccount]; - } else if (sshPassword) { - [sshTunnel setPassword:[self sshPassword]]; - } - - // Set the public key path if appropriate - if (sshKeyLocationEnabled && sshKeyLocation) { - [sshTunnel setKeyFilePath:sshKeyLocation]; - } - - // Set the callback function on the tunnel - [sshTunnel setConnectionStateChangeSelector:@selector(sshTunnelCallback:) delegate:self]; - - // Ask the tunnel to connect. This will call the callback below on success or failure, passing - // itself as an argument - retain count should be one at this point. - [sshTunnel connect]; -} - -/* - * Cancel connection. - * Currently only cleans up the SSH connection (MySQL connection isn't threaded) - */ -- (void)cancelConnection -{ - if (!sshTunnel) return; - - cancellingConnection = YES; - - [sshTunnel disconnect]; - [sshTunnel release]; - - sshTunnel = nil; -} - -/* - * A callback function for the SSH Tunnel setup process - will be called on a connection - * state change, allowing connection to fail or proceed as appropriate. If successful, - * will call initiateMySQLConnection. - */ -- (void)sshTunnelCallback:(SPSSHTunnel *)theTunnel -{ - if (cancellingConnection) return; - NSInteger newState = [theTunnel state]; - - if (newState == PROXY_STATE_IDLE) { - [tableDocument setTitlebarStatus:NSLocalizedString(@"SSH Disconnected", @"SSH disconnected titlebar marker")]; - [self failConnectionWithTitle:NSLocalizedString(@"SSH connection failed!", @"SSH connection failed title") errorMessage:[theTunnel lastError] detail:[sshTunnel debugMessages]]; - } else if (newState == PROXY_STATE_CONNECTED) { - [tableDocument setTitlebarStatus:NSLocalizedString(@"SSH Connected", @"SSH connected titlebar marker")]; - [self initiateMySQLConnection]; - } else { - [tableDocument setTitlebarStatus:NSLocalizedString(@"SSH Connecting…", @"SSH connecting titlebar marker")]; - } -} - -/* - * Set up the MySQL connection, either through a successful tunnel or directly in the background. - */ -- (void)initiateMySQLConnection -{ - // Disable the favorites table view to prevent further connections attempts - [favoritesTable setEnabled:NO]; - - if (sshTunnel) - [progressIndicatorText setStringValue:NSLocalizedString(@"MySQL connecting...", @"MySQL connecting very short status message")]; - else - [progressIndicatorText setStringValue:NSLocalizedString(@"Connecting...", @"Generic connecting very short status message")]; - - [progressIndicatorText display]; - - [connectButton setTitle:NSLocalizedString(@"Cancel", @"cancel button")]; - [connectButton setAction:@selector(cancelMySQLConnection:)]; - [connectButton setEnabled:YES]; - [connectButton display]; - - [NSThread detachNewThreadSelector:@selector(_initiateMySQLConnectionInBackground) toTarget:self withObject:nil]; -} - -/* - * Ends a connection attempt by stopping the connection animation and - * displaying a specified error message. - */ -- (void)failConnectionWithTitle:(NSString *)theTitle errorMessage:(NSString *)theErrorMessage detail:(NSString *)errorDetail -{ - BOOL isSSHTunnelBindError = NO; - - // Clean up the interface - [progressIndicator stopAnimation:self]; - [progressIndicator display]; - [progressIndicatorText setHidden:YES]; - [progressIndicatorText display]; - [addToFavoritesButton setHidden:NO]; - [addToFavoritesButton display]; - [connectButton setEnabled:YES]; - [tableDocument clearStatusIcon]; - - // Release as appropriate - if (sshTunnel) { - [sshTunnel disconnect], [sshTunnel release], sshTunnel = nil; - - // If the SSH tunnel connection failed because the port it was trying to bind to was already in use take note - // of it so we can give the user the option of connecting via standard connection and use the existing tunnel. - if ([theErrorMessage rangeOfString:@"bind"].location != NSNotFound) { - isSSHTunnelBindError = YES; - } - } - - if (errorDetail) [errorDetailText setString:errorDetail]; - - // Inform the delegate that the connection attempt failed - if (delegate && [delegate respondsToSelector:@selector(connectionControllerConnectAttemptFailed:)]) { - [delegate connectionControllerConnectAttemptFailed:self]; - } - - // Only display the connection error message if there is a window visible and the connection attempt - // wasn't cancelled even though it failed. - if ([[tableDocument parentWindow] isVisible] && (!mySQLConnectionCancelled)) { - SPBeginAlertSheet(theTitle, NSLocalizedString(@"OK", @"OK button"), (errorDetail) ? NSLocalizedString(@"Show Detail", @"Show detail button") : nil, (isSSHTunnelBindError) ? NSLocalizedString(@"Use Standard Connection", @"use standard connection button") : nil, [tableDocument parentWindow], self, @selector(connectionFailureSheetDidEnd:returnCode:contextInfo:), @"connect", theErrorMessage); - } -} - -/** - * Alert sheet callback method - invoked when an error sheet is closed. - */ -- (void)connectionFailureSheetDidEnd:(NSAlert *)alert returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo -{ - // Restore the passwords from keychain for editing if appropriate - if (connectionKeychainItemName) { - [self setPassword:[keychain getPasswordForName:connectionKeychainItemName account:connectionKeychainItemAccount]]; - } - if (connectionSSHKeychainItemName) { - [self setSshPassword:[keychain getPasswordForName:connectionSSHKeychainItemName account:connectionSSHKeychainItemAccount]]; - } - - if (returnCode == NSAlertAlternateReturn) { - [errorDetailText setFont:[NSFont userFontOfSize:12]]; - [errorDetailText setAlignment:NSLeftTextAlignment]; - [errorDetailWindow makeKeyAndOrderFront:self]; - } - // Currently only SSH port bind errors offer a 3rd option in the error dialog, but if this ever changes - // this will definitely need to be updated. - else if (returnCode == NSAlertOtherReturn) { - // Extract the local port number that SSH attempted to bind to from the debug output - NSString *tunnelPort = [[[errorDetailText string] componentsMatchedByRegex:@"LOCALHOST:([0-9]+)" capture:1L] lastObject]; - - // Change the connection type to standard TCP/IP - [self setType:SPTCPIPConnection]; - - // Change connection details - [self setPort:tunnelPort]; - [self setHost:@"127.0.0.1"]; - - // Change to standard TCP/IP connection view - [self resizeTabViewToConnectionType:SPTCPIPConnection animating:YES]; - - // Initiate the connection after half a second to give the connection view a chance to resize - [self performSelector:@selector(initiateConnection:) withObject:self afterDelay:0.5]; - } -} +#pragma mark - +#pragma mark Interface interaction /** - * Add the connection to the parent document and restore the - * interface, allowing the application to run as normal. + * Registered in initWithDocument: to be the double click action of the favorites outline view. */ -- (void)addConnectionToDocument +- (IBAction)nodeDoubleClicked:(id)sender { - // Hide the connection view and restore the main view - [connectionView removeFromSuperviewWithoutNeedingDisplay]; - [databaseConnectionView setHidden:NO]; - - // Restore the toolbar icons - NSArray *toolbarItems = [[[tableDocument parentWindow] toolbar] items]; - - for (NSInteger i = 0; i < [toolbarItems count]; i++) [[toolbarItems objectAtIndex:i] setEnabled:YES]; - - // Set keychain id for saving SPF files - if ([self valueForKeyPath:@"selectedFavorite.id"]) { - [tableDocument setKeychainID:[[self valueForKeyPath:@"selectedFavorite.id"] stringValue]]; + SPTreeNode *node = [self selectedFavoriteNode]; + + // Only proceed to initiate a connection if a leaf node (i.e. a favorite and not a group) was double clicked. + if (![node isGroup]) { + [self initiateConnection:self]; } + // Otherwise start editing the group node's name else { - [tableDocument setKeychainID:@""]; + [favoritesOutlineView editColumn:0 row:[favoritesOutlineView selectedRow] withEvent:nil select:YES]; } - - // Pass the connection to the table document, allowing it to set - // up the other classes and the rest of the interface. - [tableDocument setConnection:mySQLConnection]; } -#pragma mark - -#pragma mark Interface interaction - /** * Opens the SSH/SSL key selection window, ready to select a key file. */ - (IBAction)chooseKeyLocation:(id)sender { - [favoritesTable deselectAll:self]; + [favoritesOutlineView deselectAll:self]; NSString *directoryPath = nil; NSString *filePath = nil; NSArray *permittedFileTypes = nil; @@ -569,7 +413,7 @@ } permittedFileTypes = [NSArray arrayWithObjects:@"pem", @"key", @"", nil]; [openPanel setAccessoryView:sslKeyFileLocationHelp]; - + // SSL certificate file location: } else if (sender == standardSSLCertificateButton || sender == socketSSLCertificateButton) { if ([sender state] == NSOffState) { @@ -578,7 +422,7 @@ } permittedFileTypes = [NSArray arrayWithObjects:@"pem", @"cert", @"", nil]; [openPanel setAccessoryView:sslCertificateLocationHelp]; - + // SSL CA certificate file location: } else if (sender == standardSSLCACertButton || sender == socketSSLCACertButton) { if ([sender state] == NSOffState) { @@ -592,72 +436,14 @@ [openPanel beginSheetForDirectory:directoryPath file:filePath types:permittedFileTypes - modalForWindow:[tableDocument parentWindow] + modalForWindow:[dbDocument parentWindow] modalDelegate:self didEndSelector:@selector(chooseKeyLocationSheetDidEnd:returnCode:contextInfo:) contextInfo:sender]; } /** - * Called after closing the SSH/SSL key selection sheet. - */ -- (void)chooseKeyLocationSheetDidEnd:(NSOpenPanel *)openPanel returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo -{ - NSString *abbreviatedFileName = [[openPanel filename] stringByAbbreviatingWithTildeInPath]; - - // SSH key file selection - if (contextInfo == sshSSHKeyButton) { - if (returnCode == NSCancelButton) { - [self setSshKeyLocationEnabled:NSOffState]; - return; - } - [self setSshKeyLocation:abbreviatedFileName]; - - // SSL key file selection - } else if (contextInfo == standardSSLKeyFileButton || contextInfo == socketSSLKeyFileButton) { - if (returnCode == NSCancelButton) { - [self setSslKeyFileLocationEnabled:NSOffState]; - [self setSslKeyFileLocation:nil]; - return; - } - [self setSslKeyFileLocation:abbreviatedFileName]; - - // SSL certificate file selection - } else if (contextInfo == standardSSLCertificateButton || contextInfo == socketSSLCertificateButton) { - if (returnCode == NSCancelButton) { - [self setSslCertificateFileLocationEnabled:NSOffState]; - [self setSslCertificateFileLocation:nil]; - return; - } - [self setSslCertificateFileLocation:abbreviatedFileName]; - - // SSL CA certificate file selection - } else if (contextInfo == standardSSLCACertButton || contextInfo == socketSSLCACertButton) { - if (returnCode == NSCancelButton) { - [self setSslCACertFileLocationEnabled:NSOffState]; - [self setSslCACertFileLocation:nil]; - return; - } - [self setSslCACertFileLocation:abbreviatedFileName]; - } -} - -/** - * Opens the preferences window, or brings it to the front, and switch to the favorites tab. - * If a favorite is selected in the connection sheet, it is also select in the prefs window. - */ -- (IBAction)editFavorites:(id)sender -{ - SPPreferenceController *prefsController = [[NSApp delegate] preferenceController]; - - [prefsController showWindow:self]; - [prefsController displayFavoritePreferences:self]; - - if ([favoritesTable numberOfSelectedRows]) [[prefsController favoritesPreferencePane] selectFavorites:[NSArray arrayWithObject:[self valueForKeyPath:@"selectedFavorite"]]]; -} - -/** - * Show connection help. + * Show connection help webpage. */ - (IBAction)showHelp:(id)sender { @@ -676,83 +462,6 @@ #pragma mark Connection details interaction and display /** - * Trigger a resize action whenever the tab view changes. The connection - * detail forms are held within container views, which are of a fixed width; - * the tabview and buttons are contained within a resizable view which - * is set to dimensions based on the container views, allowing the view - * to be sized according to the detail type. - */ -- (void)tabView:(NSTabView *)tabView didSelectTabViewItem:(NSTabViewItem *)tabViewItem -{ - NSInteger selectedTabView = [tabView indexOfTabViewItem:tabViewItem]; - - // Deselect any selected favorite for manual changes - if (!automaticFavoriteSelection) [favoritesTable deselectAll:self]; - automaticFavoriteSelection = NO; - - if (selectedTabView == previousType) return; - - [self resizeTabViewToConnectionType:selectedTabView animating:YES]; - - // Update the host as appropriate - if ((selectedTabView != SPSocketConnection) && [[self host] isEqualToString:@"localhost"]) { - [self setHost:@""]; - } - - previousType = selectedTabView; -} - -/** - * As the scrollview resizes, keep the details centered within it if - * the detail frame is larger than the scrollview size; otherwise, pin - * the detail frame to the top of the scrollview. - */ -- (void)scrollViewFrameChanged:(NSNotification *)aNotification -{ - NSRect scrollViewFrame = [connectionDetailsScrollView frame]; - NSRect scrollDocumentFrame = [[connectionDetailsScrollView documentView] frame]; - NSRect connectionDetailsFrame = [connectionResizeContainer frame]; - - // Scroll view is smaller than contents - keep positioned at top. - if (scrollViewFrame.size.height < connectionDetailsFrame.size.height + 10) { - if (connectionDetailsFrame.origin.y != 0) { - connectionDetailsFrame.origin.y = 0; - [connectionResizeContainer setFrame:connectionDetailsFrame]; - scrollDocumentFrame.size.height = connectionDetailsFrame.size.height + 10; - [[connectionDetailsScrollView documentView] setFrame:scrollDocumentFrame]; - } - - // Otherwise, center. - } else { - connectionDetailsFrame.origin.y = (scrollViewFrame.size.height - connectionDetailsFrame.size.height)/3; - [connectionResizeContainer setFrame:connectionDetailsFrame]; - scrollDocumentFrame.size.height = scrollViewFrame.size.height; - [[connectionDetailsScrollView documentView] setFrame:scrollDocumentFrame]; - } -} - -/** - * When a favorite is selected, and the connection details are edited, deselect the favorite; - * this is clearer and also prevents a failed connection from being repopulated with the - * favorite's details instead of the last used details. - */ -- (void)controlTextDidChange:(NSNotification *)aNotification -{ - [favoritesTable deselectAll:self]; -} - -/** - * When a host field finishes editing, ensure that it hasn't been set to "localhost" - * to ensure that socket connections don't inadvertently occur. - */ -- (void)controlTextDidEndEditing:(NSNotification *)notification -{ - if ([notification object] == standardSQLHostField || [notification object] == sshSQLHostField) { - [self checkHost]; - } -} - -/** * Control tab view resizing based on the supplied connection type, * with an option defining whether it should be animated or not. */ @@ -775,49 +484,15 @@ case SPSSHTunnelConnection: targetResizeRect = [sshConnectionFormContainer frame]; break; - } + } frameRect.size.height = targetResizeRect.size.height + additionalFormHeight; if (animate) { [[connectionResizeContainer animator] setFrame:frameRect]; - } else { - [connectionResizeContainer setFrame:frameRect]; - } -} - -/** - * Check the host field and ensure it isn't set to "localhost" for - * non-socket connections. - */ -- (BOOL)checkHost -{ - if ([self type] != SPSocketConnection && [[self host] isEqualToString:@"localhost"]) { - SPBeginAlertSheet(NSLocalizedString(@"You have entered 'localhost' for a non-socket connection", @"title of error when using 'localhost' for a network connection"), - NSLocalizedString(@"Use 127.0.0.1", @"Use 127.0.0.1 button"), // Main button - NSLocalizedString(@"Connect via socket", @"Connect via socket button"), // Alternate button - nil, // Other button - [tableDocument parentWindow], // Window to attach to - self, // Modal delegate - @selector(localhostErrorSheetDidEnd:returnCode:contextInfo:), // Did end selector - nil, // Contextual info for selectors - NSLocalizedString(@"To MySQL, 'localhost' is a special host and means that a socket connection should be used.\n\nDid you mean to use a socket connection, or to connect to the local machine via a port? If you meant to connect via a port, '127.0.0.1' should be used instead of 'localhost'.", @"message of error when using 'localhost' for a network connection")); - return NO; - } - - return YES; -} - -/** - * Alert sheet callback method - invoked when the error sheet is closed. - */ -- (void)localhostErrorSheetDidEnd:(NSAlert *)alert returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo -{ - if (returnCode == NSAlertAlternateReturn) { - [self setType:SPSocketConnection]; - [self setHost:@""]; - } else { - [self setHost:@"127.0.0.1"]; + } + else { + [connectionResizeContainer setFrame:frameRect]; } } @@ -828,17 +503,17 @@ * Sorts the favorites table view based on the selected sort by item. */ - (void)sortFavorites:(id)sender -{ +{ previousSortItem = currentSortItem; currentSortItem = [[sender menu] indexOfItem:sender]; - + [prefs setInteger:currentSortItem forKey:SPFavoritesSortedBy]; - + // Perform sorting [self _sortFavorites]; - + if (previousSortItem > -1) [[[sender menu] itemAtIndex:previousSortItem] setState:NSOffState]; - + [[[sender menu] itemAtIndex:currentSortItem] setState:NSOnState]; } @@ -848,36 +523,13 @@ - (void)reverseSortFavorites:(id)sender { reverseFavoritesSort = (![sender state]); - + [prefs setBool:reverseFavoritesSort forKey:SPFavoritesSortedInReverse]; - + // Perform re-sorting [self _sortFavorites]; - - [sender setState:reverseFavoritesSort]; -} - -/** - * Updates the local favorites array from the user defaults - */ -- (void)updateFavorites -{ - [favoritesTable deselectAll:self]; - - if (favorites) [favorites release]; - - if ([prefs objectForKey:SPFavorites]) { - favorites = [[NSMutableArray alloc] initWithArray:[prefs objectForKey:SPFavorites]]; - } - else { - favorites = [[NSMutableArray alloc] init]; - } - - [self _buildFavoritesTree]; - - [favoritesTable reloadData]; - - [favoritesTable expandItem:[[favoritesRoot nodeChildren] objectAtIndex:0]]; + + [sender setState:reverseFavoritesSort]; } /** @@ -885,9 +537,6 @@ */ - (void)updateFavoriteSelection:(id)sender { - // If nothing is selected, return without updating the interface - if (![self selectedFavorite]) return; - automaticFavoriteSelection = YES; // Clear the keychain referral items as appropriate @@ -895,10 +544,19 @@ if (connectionKeychainItemAccount) [connectionKeychainItemAccount release], connectionKeychainItemAccount = nil; if (connectionSSHKeychainItemName) [connectionSSHKeychainItemName release], connectionSSHKeychainItemName = nil; if (connectionSSHKeychainItemAccount) [connectionSSHKeychainItemAccount release], connectionSSHKeychainItemAccount = nil; - + + SPTreeNode *node = [self selectedFavoriteNode]; + // Update key-value properties from the selected favourite, using empty strings where not found - NSDictionary *fav = [self selectedFavorite]; - + NSDictionary *fav = [[node representedObject] nodeFavorite]; + + // Keep a copy of the favorite as it currently stands + if (currentFavorite) [currentFavorite release], currentFavorite = nil; + + currentFavorite = [[node representedObject] copy]; + + [connectionResizeContainer setHidden:NO]; + // Standard details [self setType:([fav objectForKey:SPFavoriteTypeKey] ? [[fav objectForKey:SPFavoriteTypeKey] integerValue] : SPTCPIPConnection)]; [self setName:([fav objectForKey:SPFavoriteNameKey] ? [fav objectForKey:SPFavoriteNameKey] : @"")]; @@ -907,7 +565,7 @@ [self setUser:([fav objectForKey:SPFavoriteUserKey] ? [fav objectForKey:SPFavoriteUserKey] : @"")]; [self setPort:([fav objectForKey:SPFavoritePortKey] ? [fav objectForKey:SPFavoritePortKey] : @"")]; [self setDatabase:([fav objectForKey:SPFavoriteDatabaseKey] ? [fav objectForKey:SPFavoriteDatabaseKey] : @"")]; - + // SSL details [self setUseSSL:([fav objectForKey:SPFavoriteUseSSLKey] ? [[fav objectForKey:SPFavoriteUseSSLKey] intValue] : NSOffState)]; [self setSslKeyFileLocationEnabled:([fav objectForKey:SPFavoriteSSLKeyFileLocationEnabledKey] ? [[fav objectForKey:SPFavoriteSSLKeyFileLocationEnabledKey] intValue] : NSOffState)]; @@ -916,89 +574,173 @@ [self setSslCertificateFileLocation:([fav objectForKey:SPFavoriteSSLCertificateFileLocationKey] ? [fav objectForKey:SPFavoriteSSLCertificateFileLocationKey] : @"")]; [self setSslCACertFileLocationEnabled:([fav objectForKey:SPFavoriteSSLCACertFileLocationEnabledKey] ? [[fav objectForKey:SPFavoriteSSLCACertFileLocationEnabledKey] intValue] : NSOffState)]; [self setSslCACertFileLocation:([fav objectForKey:SPFavoriteSSLCACertFileLocationKey] ? [fav objectForKey:SPFavoriteSSLCACertFileLocationKey] : @"")]; - + // SSH details [self setSshHost:([fav objectForKey:SPFavoriteSSHHostKey] ? [fav objectForKey:SPFavoriteSSHHostKey] : @"")]; [self setSshUser:([fav objectForKey:SPFavoriteSSHUserKey] ? [fav objectForKey:SPFavoriteSSHUserKey] : @"")]; [self setSshKeyLocationEnabled:([fav objectForKey:SPFavoriteSSHKeyLocationEnabledKey] ? [[fav objectForKey:SPFavoriteSSHKeyLocationEnabledKey] intValue] : NSOffState)]; [self setSshKeyLocation:([fav objectForKey:SPFavoriteSSHKeyLocationKey] ? [fav objectForKey:SPFavoriteSSHKeyLocationKey] : @"")]; [self setSshPort:([fav objectForKey:SPFavoriteSSHPortKey] ? [fav objectForKey:SPFavoriteSSHPortKey] : @"")]; - + // Trigger an interface update [self resizeTabViewToConnectionType:[self type] animating:YES]; - + // Check whether the password exists in the keychain, and if so add it; also record the // keychain details so we can pass around only those details if the password doesn't change connectionKeychainItemName = [[keychain nameForFavoriteName:[self valueForKeyPath:@"selectedFavorite.name"] id:[self valueForKeyPath:@"selectedFavorite.id"]] retain]; connectionKeychainItemAccount = [[keychain accountForUser:[self valueForKeyPath:@"selectedFavorite.user"] host:(([self type] == SPSocketConnection)?@"localhost":[self valueForKeyPath:@"selectedFavorite.host"]) database:[self valueForKeyPath:@"selectedFavorite.database"]] retain]; - + [self setPassword:[keychain getPasswordForName:connectionKeychainItemName account:connectionKeychainItemAccount]]; - + if (![[self password] length]) { [self setPassword:nil]; [connectionKeychainItemName release], connectionKeychainItemName = nil; [connectionKeychainItemAccount release], connectionKeychainItemAccount = nil; } - + // And the same for the SSH password connectionSSHKeychainItemName = [[keychain nameForSSHForFavoriteName:[self valueForKeyPath:@"selectedFavorite.name"] id:[self valueForKeyPath:@"selectedFavorite.id"]] retain]; connectionSSHKeychainItemAccount = [[keychain accountForSSHUser:[self valueForKeyPath:@"selectedFavorite.sshUser"] sshHost:[self valueForKeyPath:@"selectedFavorite.sshHost"]] retain]; - + [self setSshPassword:[keychain getPasswordForName:connectionSSHKeychainItemName account:connectionSSHKeychainItemAccount]]; - + if (![[self sshPassword] length]) { [self setSshPassword:nil]; [connectionSSHKeychainItemName release], connectionSSHKeychainItemName = nil; [connectionSSHKeychainItemAccount release], connectionSSHKeychainItemAccount = nil; } - - [prefs setInteger:([favoritesTable selectedRow] - 1) forKey:SPLastFavoriteIndex]; - - // Set next KeyView to password field if it is empty - switch ([self type]) + + [prefs setInteger:([favoritesOutlineView selectedRow] - 1) forKey:SPLastFavoriteID]; + + // Set first responder to password field if it is empty + switch ([self type]) { case SPTCPIPConnection: - if (![[standardPasswordField stringValue] length]) [favoritesTable setNextKeyView:standardPasswordField]; + if (![[standardPasswordField stringValue] length]) [[dbDocument parentWindow] makeFirstResponder:standardPasswordField]; break; case SPSocketConnection: - if (![[socketPasswordField stringValue] length]) [favoritesTable setNextKeyView:socketPasswordField]; + if (![[socketPasswordField stringValue] length]) [[dbDocument parentWindow] makeFirstResponder:socketPasswordField]; break; case SPSSHTunnelConnection: - if (![[sshPasswordField stringValue] length]) [favoritesTable setNextKeyView:sshPasswordField]; + if (![[sshPasswordField stringValue] length]) [[dbDocument parentWindow] makeFirstResponder:sshPasswordField]; break; } } /** - * Returns a KVC-compliant proxy to the currently selected favorite, or nil if nothing selected. + * Returns the selected favorite data dictionary or nil if nothing is selected. + */ +- (NSMutableDictionary *)selectedFavorite +{ + SPTreeNode *node = [self selectedFavoriteNode]; + + return (![node isGroup]) ? [[node representedObject] nodeFavorite] : nil; +} + +/** + * Returns the selected favorite node or nil if nothing is selected. */ -- (id)selectedFavorite +- (SPTreeNode *)selectedFavoriteNode { - if ([favoritesTable selectedRow] == -1) return nil; + NSArray *nodes = [self selectedFavoriteNodes]; + + return ([nodes count]) ? (SPTreeNode *)[[self selectedFavoriteNodes] objectAtIndex:0] : nil; +} - return [favorites objectAtIndex:([favoritesTable selectedRow] - 1)]; +/** + * Returns an array of selected favorite nodes. + */ +- (NSArray *)selectedFavoriteNodes +{ + NSMutableArray *nodes = [NSMutableArray array]; + NSIndexSet *indexes = [favoritesOutlineView selectedRowIndexes]; + + NSUInteger currentIndex = [indexes firstIndex]; + + while (currentIndex != NSNotFound) + { + [nodes addObject:[favoritesOutlineView itemAtRow:currentIndex]]; + + currentIndex = [indexes indexGreaterThanIndex:currentIndex]; + } + + return nodes; } /** - * Adds the current details as a new favorite, select it, and scroll the selected - * row to visible. + * Adds a new connection favorite. */ - (IBAction)addFavorite:(id)sender { - NSString *thePassword, *theSSHPassword; - NSNumber *favoriteid = [NSNumber numberWithInteger:[[NSString stringWithFormat:@"%f", [[NSDate date] timeIntervalSince1970]] hash]]; - NSString *favoriteName = [[self name] length] ? [self name]:[NSString stringWithFormat:@"%@@%@", ([self user] && [[self user] length])?[self user] : @"anonymous", (([self type] == SPSocketConnection) ? @"localhost" : [self host])]; + NSNumber *favoriteID = [self _createNewFavoriteID]; + + NSArray *objects = [NSArray arrayWithObjects:NSLocalizedString(@"New Favorite", @"new favorite name"), + [NSNumber numberWithInteger:0], @"", @"", @"", @"", + [NSNumber numberWithInt:NSOffState], + [NSNumber numberWithInt:NSOffState], + [NSNumber numberWithInt:NSOffState], + [NSNumber numberWithInt:NSOffState], @"", @"", @"", + [NSNumber numberWithInt:NSOffState], @"", @"", favoriteID, nil]; + + NSArray *keys = [NSArray arrayWithObjects: + SPFavoriteNameKey, + SPFavoriteTypeKey, + SPFavoriteHostKey, + SPFavoriteSocketKey, + SPFavoriteUserKey, + SPFavoritePortKey, + SPFavoriteUseSSLKey, + SPFavoriteSSLKeyFileLocationEnabledKey, + SPFavoriteSSLCertificateFileLocationEnabledKey, + SPFavoriteSSLCACertFileLocationEnabledKey, + SPFavoriteDatabaseKey, + SPFavoriteSSHHostKey, + SPFavoriteSSHUserKey, + SPFavoriteSSHKeyLocationEnabledKey, + SPFavoriteSSHKeyLocationKey, + SPFavoriteSSHPortKey, + SPFavoriteIDKey, + nil]; + + // Create default favorite + NSMutableDictionary *favorite = [NSMutableDictionary dictionaryWithObjects:objects forKeys:keys]; + + SPTreeNode *selectedNode = [self selectedFavoriteNode]; + + SPTreeNode *parent = ([selectedNode isGroup]) ? selectedNode : [selectedNode parentNode]; + + SPTreeNode *node = [favoritesController addFavoriteNodeWithData:favorite asChildOfNode:parent]; + + [self _reloadFavoritesViewData]; + [self _selectNode:node]; + + [[[[NSApp delegate] preferenceController] generalPreferencePane] updateDefaultFavoritePopup]; + + favoriteNameFieldWasTouched = NO; + + [favoritesOutlineView editColumn:0 row:[favoritesOutlineView selectedRow] withEvent:nil select:YES]; +} +/** + * Adds the current details as a new connection favorite, selects it, and scrolls the selected + * row to be visible. + */ +- (IBAction)addFavoriteUsingCurrentDetails:(id)sender +{ + NSString *thePassword, *theSSHPassword; + NSNumber *favoriteid = [self _createNewFavoriteID]; + NSString *favoriteName = [[self name] length] ? [self name] : [NSString stringWithFormat:@"%@@%@", ([self user] && [[self user] length])?[self user] : @"anonymous", (([self type] == SPSocketConnection) ? @"localhost" : [self host])]; + if (![[self name] length] && [self database] && ![[self database] isEqualToString:@""]) { favoriteName = [NSString stringWithFormat:@"%@ %@", [self database], favoriteName]; } - + // Ensure that host is not empty if this is a TCP/IP or SSH connection if (([self type] == SPTCPIPConnection || [self type] == SPSSHTunnelConnection) && ![[self host] length]) { NSRunAlertPanel(NSLocalizedString(@"Insufficient connection details", @"insufficient details message"), NSLocalizedString(@"Insufficient details provided to establish a connection. Please provide at least a host.", @"insufficient details informative message"), NSLocalizedString(@"OK", @"OK button"), nil, nil); return; } - + // If SSH is enabled, ensure that the SSH host is not nil if ([self type] == SPSSHTunnelConnection && ![[self sshHost] length]) { NSRunAlertPanel(NSLocalizedString(@"Insufficient connection details", @"insufficient details message"), NSLocalizedString(@"Please enter the hostname for the SSH Tunnel, or disable the SSH Tunnel.", @"message of panel when ssh details are incomplete"), NSLocalizedString(@"OK", @"OK button"), nil, nil); @@ -1006,22 +748,22 @@ } // Ensure that a socket connection is not inadvertently used - if (![self checkHost]) return; - + if (![self _checkHost]) return; + // Construct the favorite details - cannot use only dictionaryWithObjectsAndKeys for possible nil values. NSMutableDictionary *newFavorite = [NSMutableDictionary dictionaryWithObjectsAndKeys: [NSNumber numberWithInteger:[self type]], SPFavoriteTypeKey, favoriteName, SPFavoriteNameKey, favoriteid, SPFavoriteIDKey, nil]; - + // Standard details if ([self host]) [newFavorite setObject:[self host] forKey:SPFavoriteHostKey]; if ([self socket]) [newFavorite setObject:[self socket] forKey:SPFavoriteSocketKey]; if ([self user]) [newFavorite setObject:[self user] forKey:SPFavoriteUserKey]; if ([self port]) [newFavorite setObject:[self port] forKey:SPFavoritePortKey]; if ([self database]) [newFavorite setObject:[self database] forKey:SPFavoriteDatabaseKey]; - + // SSL details if ([self useSSL]) [newFavorite setObject:[NSNumber numberWithInt:[self useSSL]] forKey:SPFavoriteUseSSLKey]; [newFavorite setObject:[NSNumber numberWithInt:[self sslKeyFileLocationEnabled]] forKey:SPFavoriteSSLKeyFileLocationEnabledKey]; @@ -1030,7 +772,7 @@ if ([self sslCertificateFileLocation]) [newFavorite setObject:[self sslCertificateFileLocation] forKey:SPFavoriteSSLCertificateFileLocationKey]; [newFavorite setObject:[NSNumber numberWithInt:[self sslCACertFileLocationEnabled]] forKey:SPFavoriteSSLCACertFileLocationEnabledKey]; if ([self sslCACertFileLocation]) [newFavorite setObject:[self sslCACertFileLocation] forKey:SPFavoriteSSLCACertFileLocationKey]; - + // SSH details if ([self sshHost]) [newFavorite setObject:[self sshHost] forKey:SPFavoriteSSHHostKey]; if ([self sshUser]) [newFavorite setObject:[self sshUser] forKey:SPFavoriteSSHUserKey]; @@ -1038,22 +780,13 @@ [newFavorite setObject:[NSNumber numberWithInt:[self sshKeyLocationEnabled]] forKey:SPFavoriteSSHKeyLocationEnabledKey]; if ([self sshKeyLocation]) [newFavorite setObject:[self sshKeyLocation] forKey:SPFavoriteSSHKeyLocationKey]; - // Add the new favorite to the user defaults array - NSMutableArray *currentFavorites = ([prefs objectForKey:SPFavorites]) ? [[NSMutableArray alloc] initWithArray:[prefs objectForKey:SPFavorites]] : [[NSMutableArray alloc] init]; - - [currentFavorites addObject:newFavorite]; - - [prefs setObject:[NSArray arrayWithArray:currentFavorites] forKey:SPFavorites]; - - [currentFavorites release]; - // Add the password to keychain as appropriate thePassword = [self password]; - + if (mySQLConnection && connectionKeychainItemName) { thePassword = [keychain getPasswordForName:connectionKeychainItemName account:connectionKeychainItemAccount]; } - + if (thePassword && (![thePassword isEqualToString:@""])) { [keychain addPassword:thePassword forName:[keychain nameForFavoriteName:favoriteName id:[NSString stringWithFormat:@"%lld", [favoriteid longLongValue]]] @@ -1062,71 +795,375 @@ // Add the SSH password to keychain as appropriate theSSHPassword = [self sshPassword]; - + if (mySQLConnection && connectionSSHKeychainItemName) { theSSHPassword = [keychain getPasswordForName:connectionSSHKeychainItemName account:connectionSSHKeychainItemAccount]; } - + if (theSSHPassword && (![theSSHPassword isEqualToString:@""])) { [keychain addPassword:theSSHPassword forName:[keychain nameForSSHForFavoriteName:favoriteName id:[NSString stringWithFormat:@"%lld", [favoriteid longLongValue]]] account:[keychain accountForSSHUser:[self sshUser] sshHost:[self sshHost]]]; } - - // Update the favorites list and selection - [self updateFavorites]; - - [favoritesTable selectRowIndexes:[NSIndexSet indexSetWithIndex:[favorites count]-1] byExtendingSelection:NO]; - [favoritesTable scrollRowToVisible:[favoritesTable selectedRow]]; + + SPTreeNode *node = [favoritesController addFavoriteNodeWithData:newFavorite asChildOfNode:nil]; + + [self _reloadFavoritesViewData]; + [self _selectNode:node]; // Update the favorites popup button in the preferences [[[[NSApp delegate] preferenceController] generalPreferencePane] updateDefaultFavoritePopup]; } /** - * If the favorites list in the preferences change, trigger a reload of - * the favorites table data. + * Adds a new group node to the favorites tree with a default name. Once added it is selected for editing. */ -- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context +- (IBAction)addGroup:(id)sender +{ + SPTreeNode *selectedNode = [self selectedFavoriteNode]; + + SPTreeNode *parent = ([selectedNode isGroup]) ? selectedNode : [selectedNode parentNode]; + + SPTreeNode *node = [favoritesController addGroupNodeWithName:NSLocalizedString(@"New Folder", @"new folder placeholder name") asChildOfNode:parent]; + + [self _reloadFavoritesViewData]; + [self _selectNode:node]; + + [favoritesOutlineView editColumn:0 row:[favoritesOutlineView selectedRow] withEvent:nil select:YES]; +} + +/** + * Removes the selected node. + */ +- (IBAction)removeNode:(id)sender +{ + if ([favoritesOutlineView numberOfSelectedRows] == 1) { + + SPTreeNode *node = [self selectedFavoriteNode]; + + NSString *message = @""; + NSString *informativeMessage = @""; + + if (![node isGroup]) { + message = [NSString stringWithFormat:NSLocalizedString(@"Delete favorite '%@'?", @"delete database message"), [[[node representedObject] nodeFavorite] objectForKey:SPFavoriteNameKey]]; + informativeMessage = [NSString stringWithFormat:NSLocalizedString(@"Are you sure you want to delete the favorite '%@'? This operation cannot be undone.", @"delete database informative message"), [[[node representedObject] nodeFavorite] objectForKey:SPFavoriteNameKey]]; + } + else { + message = [NSString stringWithFormat:NSLocalizedString(@"Delete group '%@'?", @"delete database message"), [[node representedObject] nodeName]]; + informativeMessage = [NSString stringWithFormat:NSLocalizedString(@"Are you sure you want to delete the group '%@'? All favorites within this group will also be deleted. This operation cannot be undone.", @"delete database informative message"), [[node representedObject] nodeName]]; + } + + NSAlert *alert = [NSAlert alertWithMessageText:message + defaultButton:NSLocalizedString(@"Delete", @"delete button") + alternateButton:NSLocalizedString(@"Cancel", @"cancel button") + otherButton:nil + informativeTextWithFormat:informativeMessage]; + + NSArray *buttons = [alert buttons]; + + // Change the alert's cancel button to have the key equivalent of return + [[buttons objectAtIndex:0] setKeyEquivalent:@"d"]; + [[buttons objectAtIndex:0] setKeyEquivalentModifierMask:NSCommandKeyMask]; + [[buttons objectAtIndex:1] setKeyEquivalent:@"\r"]; + + [alert setAlertStyle:NSCriticalAlertStyle]; + + [alert beginSheetModalForWindow:[dbDocument parentWindow] + modalDelegate:self + didEndSelector:@selector(sheetDidEnd:returnCode:contextInfo:) + contextInfo:SPRemoveNode]; + } +} + +/** + * Duplicates the selected connection favorite. + */ +- (IBAction)duplicateFavorite:(id)sender +{ + if ([favoritesOutlineView numberOfSelectedRows] == 1) { + + NSMutableDictionary *favorite = [NSMutableDictionary dictionaryWithDictionary:[self selectedFavorite]]; + + NSNumber *favoriteID = [self _createNewFavoriteID]; + + NSInteger duplicatedFavoriteType = [[favorite objectForKey:SPFavoriteTypeKey] integerValue]; + + // Update the unique ID + [favorite setObject:favoriteID forKey:SPFavoriteIDKey]; + + // Alter the name for clarity + [favorite setObject:[NSString stringWithFormat:NSLocalizedString(@"%@ Copy", @"Initial favourite name after duplicating a previous favourite"), [favorite objectForKey:SPFavoriteNameKey]] forKey:SPFavoriteNameKey]; + + // Create new keychain items if appropriate + if (password && [password length]) { + NSString *keychainName = [keychain nameForFavoriteName:[favorite objectForKey:SPFavoriteNameKey] id:[favorite objectForKey:SPFavoriteIDKey]]; + NSString *keychainAccount = [keychain accountForUser:[favorite objectForKey:SPFavoriteUserKey] host:((duplicatedFavoriteType == SPSocketConnection) ? @"localhost" : [favorite objectForKey:SPFavoriteHostKey]) database:[favorite objectForKey:SPFavoriteDatabaseKey]]; + NSString *favoritePassword = [keychain getPasswordForName:keychainName account:keychainAccount]; + + keychainName = [keychain nameForFavoriteName:[favorite objectForKey:SPFavoriteNameKey] id:[favorite objectForKey:SPFavoriteIDKey]]; + + [keychain addPassword:favoritePassword forName:keychainName account:keychainAccount]; + + favoritePassword = nil; + } + + if (sshPassword && [sshPassword length]) { + NSString *keychainSSHName = [keychain nameForSSHForFavoriteName:[favorite objectForKey:SPFavoriteNameKey] id:[favorite objectForKey:SPFavoriteIDKey]]; + NSString *keychainSSHAccount = [keychain accountForSSHUser:[favorite objectForKey:SPFavoriteSSHUserKey] sshHost:[favorite objectForKey:SPFavoriteSSHHostKey]]; + NSString *favoriteSSHPassword = [keychain getPasswordForName:keychainSSHName account:keychainSSHAccount]; + + keychainSSHName = [keychain nameForSSHForFavoriteName:[favorite objectForKey:SPFavoriteNameKey] id:[favorite objectForKey:SPFavoriteIDKey]]; + + [keychain addPassword:favoriteSSHPassword forName:keychainSSHName account:keychainSSHAccount]; + + favoriteSSHPassword = nil; + } + + SPTreeNode *selectedNode = [self selectedFavoriteNode]; + + SPTreeNode *parent = ([selectedNode isGroup]) ? selectedNode : [selectedNode parentNode]; + + SPTreeNode *node = [favoritesController addFavoriteNodeWithData:favorite asChildOfNode:parent]; + + [self _reloadFavoritesViewData]; + [self _selectNode:node]; + + [[(SPPreferenceController *)[[NSApp delegate] preferenceController] generalPreferencePane] updateDefaultFavoritePopup]; + } +} + +/** + * Switches the selected favorite/group to editing mode so it can be renamed. + */ +- (IBAction)renameFavorite:(id)sender { - if ([keyPath isEqualToString:SPFavorites]) { - [self updateFavorites]; + if ([favoritesOutlineView numberOfSelectedRows] == 1) { + [favoritesOutlineView editColumn:0 row:[favoritesOutlineView selectedRow] withEvent:nil select:YES]; } } +/** + * Marks the selected favorite as the default. + */ +- (IBAction)makeSelectedFavoriteDefault:(id)sender +{ + NSInteger favoriteID = [[[self selectedFavorite] objectForKey:SPFavoriteIDKey] integerValue]; + + [prefs setInteger:favoriteID forKey:SPDefaultFavorite]; +} + #pragma mark - -#pragma mark Menu Validation +#pragma mark Import/export favorites --(BOOL)validateMenuItem:(NSMenuItem *)menuItem +/** + * Displays an open panel, allowing the user to import their favorites. + */ +- (IBAction)importFavorites:(id)sender { - SEL action = [menuItem action]; - if ((action == @selector(sortFavorites:)) || (action == @selector(reverseSortFavorites:))) { + NSOpenPanel *openPanel = [NSOpenPanel openPanel]; + + [openPanel beginSheetForDirectory:nil + file:nil + types:nil + modalForWindow:[dbDocument parentWindow] + modalDelegate:self + didEndSelector:@selector(importExportFavoritesSheetDidEnd:returnCode:contextInfo:) + contextInfo:SPImportFavorites]; +} - // Loop all the items in the sort by menu only checking the currently selected one - for (NSMenuItem *item in [[menuItem menu] itemArray]) - { - [item setState:([[menuItem menu] indexOfItem:item] == currentSortItem) ? NSOnState : NSOffState]; +/** + * Displays a save panel, allowing the user to export their favorites. + */ +- (IBAction)exportFavorites:(id)sender +{ + NSSavePanel *savePanel = [NSSavePanel savePanel]; + + [savePanel beginSheetForDirectory:nil + file:SPExportFavoritesFilename + modalForWindow:[dbDocument parentWindow] + modalDelegate:self + didEndSelector:@selector(importExportFavoritesSheetDidEnd:returnCode:contextInfo:) + contextInfo:SPExportFavorites]; +} + +#pragma mark - +#pragma mark Key Value Observing + +/** + * This method is called as part of Key Value Observing. + */ +- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context +{ + id oldObject = [change objectForKey:NSKeyValueChangeOldKey]; + id newObject = [change objectForKey:NSKeyValueChangeNewKey]; + + if (oldObject != newObject) { + NSMutableDictionary *favorite = [self selectedFavorite]; + + [favorite setObject:(newObject) ? newObject : @"" forKey:keyPath]; + + // Save the new data to disk + [favoritesController saveFavorites]; + + [self _reloadFavoritesViewData]; + } +} + +#pragma mark - +#pragma mark Sheet methods + +/** + * Called when the user dismisses the remove node sheet. + */ +- (void)sheetDidEnd:(id)sheet returnCode:(NSInteger)returnCode contextInfo:(NSString *)contextInfo +{ + // Remove the current favorite/group + if ([contextInfo isEqualToString:SPRemoveNode]) { + if (returnCode == NSAlertDefaultReturn) { + + SPTreeNode *node = [self selectedFavoriteNode]; + + if (![node isGroup]) { + NSDictionary *favorite = [[node representedObject] nodeFavorite]; + + // Get selected favorite's details + NSString *favoriteName = [favorite objectForKey:SPFavoriteNameKey]; + NSString *favoriteUser = [favorite objectForKey:SPFavoriteUserKey]; + NSString *favoriteHost = [favorite objectForKey:SPFavoriteHostKey]; + NSString *favoriteDatabase = [favorite objectForKey:SPFavoriteDatabaseKey]; + NSString *favoriteSSHUser = [favorite objectForKey:SPFavoriteSSHUserKey]; + NSString *favoriteSSHHost = [favorite objectForKey:SPFavoriteSSHHostKey]; + NSString *favoriteID = [favorite objectForKey:SPFavoriteIDKey]; + + NSInteger favoriteType = [[favorite objectForKey:SPFavoriteTypeKey] integerValue]; + + // Remove passwords from the Keychain + [keychain deletePasswordForName:[keychain nameForFavoriteName:favoriteName id:favoriteID] + account:[keychain accountForUser:favoriteUser host:((type == SPSocketConnection) ? @"localhost" : favoriteHost) database:favoriteDatabase]]; + [keychain deletePasswordForName:[keychain nameForSSHForFavoriteName:favoriteName id:favoriteID] + account:[keychain accountForSSHUser:favoriteSSHUser sshHost:favoriteSSHHost]]; + + // Reset last used favorite + if ([[favorite objectForKey:SPFavoriteIDKey] integerValue] == [prefs integerForKey:SPLastFavoriteID]) { + [prefs setInteger:0 forKey:SPLastFavoriteID]; + } + + // Reset default favorite + if ([[favorite objectForKey:SPFavoriteIDKey] integerValue] == [prefs integerForKey:SPDefaultFavorite]) { + [prefs setInteger:[prefs integerForKey:SPLastFavoriteID] forKey:SPDefaultFavorite]; + } + } + + [favoritesController removeFavoriteNode:node]; + + [self _reloadFavoritesViewData]; + + [[(SPPreferenceController *)[[NSApp delegate] preferenceController] generalPreferencePane] updateDefaultFavoritePopup]; } + } +} - // Check or uncheck the reverse sort item - if (action == @selector(reverseSortFavorites:)) { - [menuItem setState:reverseFavoritesSort]; +/** + * Called after closing the SSH/SSL key selection sheet. + */ +- (void)chooseKeyLocationSheetDidEnd:(NSOpenPanel *)openPanel returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo +{ + NSString *abbreviatedFileName = [[openPanel filename] stringByAbbreviatingWithTildeInPath]; + + // SSH key file selection + if (contextInfo == sshSSHKeyButton) { + if (returnCode == NSCancelButton) { + [self setSshKeyLocationEnabled:NSOffState]; + return; + } + + [self setSshKeyLocation:abbreviatedFileName]; + } + // SSL key file selection + else if (contextInfo == standardSSLKeyFileButton || contextInfo == socketSSLKeyFileButton) { + if (returnCode == NSCancelButton) { + [self setSslKeyFileLocationEnabled:NSOffState]; + [self setSslKeyFileLocation:nil]; + return; + } + + [self setSslKeyFileLocation:abbreviatedFileName]; + } + // SSL certificate file selection + else if (contextInfo == standardSSLCertificateButton || contextInfo == socketSSLCertificateButton) { + if (returnCode == NSCancelButton) { + [self setSslCertificateFileLocationEnabled:NSOffState]; + [self setSslCertificateFileLocation:nil]; + return; + } + + [self setSslCertificateFileLocation:abbreviatedFileName]; + } + // SSL CA certificate file selection + else if (contextInfo == standardSSLCACertButton || contextInfo == socketSSLCACertButton) { + if (returnCode == NSCancelButton) { + [self setSslCACertFileLocationEnabled:NSOffState]; + [self setSslCACertFileLocation:nil]; + return; } - } - return YES; + + [self setSslCACertFileLocation:abbreviatedFileName]; + } +} + +/** + * Called when the user dismisses either the import of export favorites panels. + */ +- (void)importExportFavoritesSheetDidEnd:(NSOpenPanel *)openPanel returnCode:(NSInteger)returnCode contextInfo:(NSString *)contextInfo +{ + +} +/** + * Alert sheet callback method - invoked when the error sheet is closed. + */ +- (void)localhostErrorSheetDidEnd:(NSAlert *)alert returnCode:(NSInteger)returnCode contextInfo:(void *)contextInfo +{ + if (returnCode == NSAlertAlternateReturn) { + [self setType:SPSocketConnection]; + [self setHost:@""]; + } + else { + [self setHost:@"127.0.0.1"]; + } } #pragma mark - #pragma mark Private API /** + * Check the host field and ensure it isn't set to 'localhost' for non-socket connections. + */ +- (BOOL)_checkHost +{ + if ([self type] != SPSocketConnection && [[self host] isEqualToString:@"localhost"]) { + SPBeginAlertSheet(NSLocalizedString(@"You have entered 'localhost' for a non-socket connection", @"title of error when using 'localhost' for a network connection"), + NSLocalizedString(@"Use 127.0.0.1", @"Use 127.0.0.1 button"), // Main button + NSLocalizedString(@"Connect via socket", @"Connect via socket button"), // Alternate button + nil, // Other button + [dbDocument parentWindow], // Window to attach to + self, // Modal delegate + @selector(localhostErrorSheetDidEnd:returnCode:contextInfo:), // Did end selector + nil, // Contextual info for selectors + NSLocalizedString(@"To MySQL, 'localhost' is a special host and means that a socket connection should be used.\n\nDid you mean to use a socket connection, or to connect to the local machine via a port? If you meant to connect via a port, '127.0.0.1' should be used instead of 'localhost'.", @"message of error when using 'localhost' for a network connection")); + return NO; + } + + return YES; +} + +/** * Sorts the connection favorites based on the selected criteria. */ - (void)_sortFavorites { NSString *sortKey = SPFavoriteNameKey; - + switch (currentSortItem) { case SPFavoritesSortNameItem: @@ -1139,61 +1176,51 @@ sortKey = SPFavoriteTypeKey; break; } - - NSSortDescriptor *sortDescriptor = nil; - - if (currentSortItem == SPFavoritesSortTypeItem) { - sortDescriptor = [[[NSSortDescriptor alloc] initWithKey:sortKey ascending:(!reverseFavoritesSort)] autorelease]; - } - else { - sortDescriptor = [[[NSSortDescriptor alloc] initWithKey:sortKey ascending:(!reverseFavoritesSort) selector:@selector(caseInsensitiveCompare:)] autorelease]; + + // First sort the contents of all groups + for (SPTreeNode *node in [[[favoritesRoot childNodes] objectAtIndex:0] groupChildren]) + { + [[node mutableChildNodes] sortUsingSelector:@selector(compare:)]; } - - NSDictionary *first = [[favorites objectAtIndex:0] retain]; - - [favorites removeObjectAtIndex:0]; - [favorites sortUsingDescriptors:[NSArray arrayWithObject:sortDescriptor]]; - [favorites insertObject:first atIndex:0]; - - // Rebuild the favorites tree - [self _buildFavoritesTree]; - - [favoritesTable reloadData]; - - [favoritesTable expandItem:[[favoritesRoot nodeChildren] objectAtIndex:0]]; - - [first release]; + + // Secondly sort the root's leaf nodes + [[[[favoritesRoot childNodes] objectAtIndex:0] childLeafs] sortUsingSelector:@selector(compare:)]; + + [favoritesController saveFavorites]; + + [self _reloadFavoritesViewData]; } /** - * Builds a tree structure from the user's connection favorties by wrapping them in SPFavoriteNode instances. + * Updates the favorite's host when the type changes. */ -- (void)_buildFavoritesTree -{ - if (favoritesRoot) [favoritesRoot release], favoritesRoot = nil; - - favoritesRoot = [[SPFavoriteNode alloc] init]; - - // Add a dummy item to represent the favorites heading - SPFavoriteNode *favoritesNode = [[SPFavoriteNode alloc] init]; - - [favoritesNode setNodeIsGroup:YES]; - [favoritesNode setNodeName:NSLocalizedString(@"FAVORITES", @"Favorites title at the top of the sidebar")]; - - for (NSDictionary *favorite in favorites) - { - SPFavoriteNode *node2 = [[SPFavoriteNode alloc] init]; - - [node2 setNodeFavorite:favorite]; - - [[favoritesNode nodeChildren] addObject:node2]; - - [node2 release]; +- (void)_favoriteTypeDidChange +{ + NSDictionary *favorite = [[[self selectedFavoriteNode] representedObject] nodeFavorite]; + + // If either socket or host is localhost, clear. + if ((previousType != SPSocketConnection) && [[favorite objectForKey:SPFavoriteHostKey] isEqualToString:@"localhost"]) { + [self setHost:@""]; } + + // Update the name for newly added favorites if not already touched by the user, by trigger a KVO update + if (!favoriteNameFieldWasTouched) { + [self setName:[NSString stringWithFormat:@"%@@%@", + ([favorite objectForKey:SPFavoriteUserKey]) ? [favorite objectForKey:SPFavoriteUserKey] : @"", + ((previousType == SPSocketConnection) ? @"localhost" : + (([favorite objectForKey:SPFavoriteHostKey]) ? [favorite valueForKeyPath:SPFavoriteHostKey] : @"")) + ]]; + } +} - [[favoritesRoot nodeChildren] addObject:favoritesNode]; - - [favoritesNode release]; +/** + * Convenience method for reloading the outline view, expanding the root item and scrolling to the selected item. + */ +- (void)_reloadFavoritesViewData +{ + [favoritesOutlineView reloadData]; + [favoritesOutlineView expandItem:[[favoritesRoot childNodes] objectAtIndex:0] expandChildren:YES]; + [favoritesOutlineView scrollRowToVisible:[favoritesOutlineView selectedRow]]; } /** @@ -1203,13 +1230,13 @@ { // Must be performed on the main thread if (![NSThread isMainThread]) return [[self onMainThread] _restoreConnectionInterface]; - + // Reset the window title - [[tableDocument parentWindow] setTitle:[tableDocument displayName]]; - + [[dbDocument parentWindow] setTitle:[dbDocument displayName]]; + // Stop the current tab's progress indicator - [tableDocument setIsProcessing:NO]; - + [dbDocument setIsProcessing:NO]; + // Reset the UI [addToFavoritesButton setHidden:NO]; [addToFavoritesButton display]; @@ -1222,47 +1249,56 @@ [progressIndicator display]; [progressIndicatorText setHidden:YES]; [progressIndicatorText display]; - + // Re-enable favorites table view - [favoritesTable setEnabled:YES]; - [favoritesTable display]; - + [favoritesOutlineView setEnabled:YES]; + [favoritesOutlineView display]; + mySQLConnectionCancelled = NO; - + // Revert the connect button back to its original selector [connectButton setAction:@selector(initiateConnection:)]; } /** + * Selected the supplied node in the favorites outline view. + */ +- (void)_selectNode:(SPTreeNode *)node +{ + [favoritesOutlineView selectRowIndexes:[NSIndexSet indexSetWithIndex:[favoritesOutlineView rowForItem:node]] byExtendingSelection:NO]; + [favoritesOutlineView scrollRowToVisible:[favoritesOutlineView selectedRow]]; +} + +/** * Called on the main thread once the MySQL connection is established on the background thread. Either the - * connection was cancelled or it was successful. + * connection was cancelled or it was successful. */ - (void)_mySQLConnectionEstablished -{ +{ isConnecting = NO; - - // If the user hit cancel during the connection attempt, kill the connection once + + // If the user hit cancel during the connection attempt, kill the connection once // established and reset the UI. - if (mySQLConnectionCancelled) { + if (mySQLConnectionCancelled) { if ([mySQLConnection isConnected]) { [mySQLConnection disconnect]; [mySQLConnection release], mySQLConnection = nil; } - + // Kill the SSH connection if present [self cancelConnection]; - + [self _restoreConnectionInterface]; - + return; } - + [progressIndicatorText setStringValue:NSLocalizedString(@"Connected", @"connection established message")]; [progressIndicatorText display]; - + // Stop the current tab's progress indicator - [tableDocument setIsProcessing:NO]; - + [dbDocument setIsProcessing:NO]; + // Successful connection! [connectButton setEnabled:NO]; [connectButton display]; @@ -1273,19 +1309,20 @@ // If SSL was enabled, check it was established correctly if (useSSL && ([self type] == SPTCPIPConnection || [self type] == SPSocketConnection)) { if (![mySQLConnection isConnectedViaSSL]) { - SPBeginAlertSheet(NSLocalizedString(@"SSL connection not established", @"SSL requested but not used title"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [tableDocument parentWindow], nil, nil, nil, NSLocalizedString(@"You requested that the connection should be established using SSL, but MySQL made the connection without SSL.\n\nThis may be because the server does not support SSL connections, or has SSL disabled; or insufficient details were supplied to establish an SSL connection.\n\nThis connection is not encrypted.", @"SSL connection requested but not established error detail")); - } else { - [tableDocument setStatusIconToImageWithName:@"titlebarlock"]; + SPBeginAlertSheet(NSLocalizedString(@"SSL connection not established", @"SSL requested but not used title"), NSLocalizedString(@"OK", @"OK button"), nil, nil, [dbDocument parentWindow], nil, nil, nil, NSLocalizedString(@"You requested that the connection should be established using SSL, but MySQL made the connection without SSL.\n\nThis may be because the server does not support SSL connections, or has SSL disabled; or insufficient details were supplied to establish an SSL connection.\n\nThis connection is not encrypted.", @"SSL connection requested but not established error detail")); + } + else { + [dbDocument setStatusIconToImageWithName:@"titlebarlock"]; } } // Re-enable favorites table view - [favoritesTable setEnabled:YES]; - [favoritesTable display]; - + [favoritesOutlineView setEnabled:YES]; + [favoritesOutlineView display]; + // Release the tunnel if set - will now be retained by the connection if (sshTunnel) [sshTunnel release], sshTunnel = nil; - + // Pass the connection to the document and clean up the interface [self addConnectionToDocument]; } @@ -1296,11 +1333,11 @@ - (void)_initiateMySQLConnectionInBackground { NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init]; - + // Initialise to socket if appropriate. if ([self type] == SPSocketConnection) { mySQLConnection = [[MCPConnection alloc] initToSocket:[self socket] withLogin:[self user]]; - + // Otherwise, initialise to host, using tunnel if appropriate } else { if ([self type] == SPSSHTunnelConnection) { @@ -1311,11 +1348,11 @@ } else { mySQLConnection = [[MCPConnection alloc] initToHost:[self host] withLogin:[self user] - usingPort:([[self port] length]?[[self port] integerValue]:3306)]; + usingPort:([[self port] length] ? [[self port] integerValue] : 3306)]; } } - - // Only set the password if there is no Keychain item set. The connection will ask the delegate for passwords in the Keychain. + + // Only set the password if there is no Keychain item set. The connection will ask the delegate for passwords in the Keychain. if (!connectionKeychainItemName && [self password]) { [mySQLConnection setPassword:[self password]]; } @@ -1327,28 +1364,28 @@ certificatePath:[self sslCertificateFileLocationEnabled] ? [self sslCertificateFileLocation] : nil certificateAuthorityCertificatePath:[self sslCACertFileLocationEnabled] ? [self sslCACertFileLocation] : nil]; } - + // Connection delegate must be set before actual connection attempt is made - [mySQLConnection setDelegate:tableDocument]; + [mySQLConnection setDelegate:dbDocument]; // Set whether or not we should enable delegate logging according to the prefs [mySQLConnection setDelegateQueryLogging:[prefs boolForKey:SPConsoleEnableLogging]]; - + // Set options from preferences [mySQLConnection setConnectionTimeout:[[prefs objectForKey:SPConnectionTimeoutValue] integerValue]]; [mySQLConnection setUseKeepAlive:[[prefs objectForKey:SPUseKeepAlive] boolValue]]; [mySQLConnection setKeepAliveInterval:[[prefs objectForKey:SPKeepAliveInterval] doubleValue]]; - + // Connect [mySQLConnection connect]; - + if (![mySQLConnection isConnected]) { if (sshTunnel) { - + // If an SSH tunnel is running, temporarily block to allow the tunnel to register changes in state [[NSRunLoop currentRunLoop] runMode:NSModalPanelRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.2]]; - + // If the state is connection refused, attempt the MySQL connection again with the host using the hostfield value. if ([sshTunnel state] == PROXY_STATE_FORWARDING_FAILED) { if ([sshTunnel localPortFallback]) { @@ -1360,7 +1397,7 @@ } } } - + if (![mySQLConnection isConnected]) { NSString *errorMessage = @""; if (sshTunnel && [sshTunnel state] == PROXY_STATE_FORWARDING_FAILED) { @@ -1379,56 +1416,183 @@ errorMessage = [NSString stringWithFormat:NSLocalizedString(@"Unable to connect to host %@, or the request timed out.\n\nBe sure that the address is correct and that you have the necessary privileges, or try increasing the connection timeout (currently %ld seconds).\n\nMySQL said: %@", @"message of panel when connection to host failed"), [self host], (long)[[prefs objectForKey:SPConnectionTimeoutValue] integerValue], [mySQLConnection getLastErrorMessage]]; [[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"Connection failed!", @"connection failed title") errorMessage:errorMessage detail:nil]; } - + // Tidy up isConnecting = NO; - + if (sshTunnel) [sshTunnel release], sshTunnel = nil; - + [mySQLConnection release], mySQLConnection = nil; [self _restoreConnectionInterface]; [pool release]; - + return; } } - + if ([self database] && ![[self database] isEqualToString:@""]) { if (![mySQLConnection selectDB:[self database]]) { [[self onMainThread] failConnectionWithTitle:NSLocalizedString(@"Could not select database", @"message when database selection failed") errorMessage:[NSString stringWithFormat:NSLocalizedString(@"Connected to host, but unable to connect to database %@.\n\nBe sure that the database exists and that you have the necessary privileges.\n\nMySQL said: %@", @"message of panel when connection to db failed"), [self database], [mySQLConnection getLastErrorMessage]] detail:nil]; - + // Tidy up isConnecting = NO; - + if (sshTunnel) [sshTunnel release], sshTunnel = nil; - + [mySQLConnection release], mySQLConnection = nil; [self _restoreConnectionInterface]; [pool release]; - + return; } } - + // Connection established [self performSelectorOnMainThread:@selector(_mySQLConnectionEstablished) withObject:nil waitUntilDone:NO]; - + [pool release]; } -@end +/** + * Creates a new favorite ID based on the UNIX epoch time. + */ +- (NSNumber *)_createNewFavoriteID +{ + return [NSNumber numberWithInteger:[[NSString stringWithFormat:@"%f", [[NSDate date] timeIntervalSince1970]] hash]]; +} -#pragma mark - -#pragma mark NSView subclass - flipped view for simpler drawing +/** + * Returns the favorite node for the conection favorite with the supplied ID. + */ +- (SPTreeNode *)_favoriteNodeForFavoriteID:(NSInteger)favoriteID +{ + SPTreeNode *node = nil; + + if (!favoritesRoot) return; + + for (node in [favoritesRoot allChildLeafs]) + { + if ([[[[node representedObject] nodeFavorite] objectForKey:SPFavoriteIDKey] integerValue] == favoriteID) { + return node; + } + } +} /** - * Add an implementation of a flipped view to simplify drawing. + * Check all fields used in the keychain names against the old values for that + * favorite, and update the keychain names to match if necessary. + * If an (optional) recognised password field is supplied, that field is assumed + * to have changed and is used to supply the new value. */ -@implementation SPFlippedView: NSView +- (void)_updateFavoritePasswordsFromField:(NSControl *)control +{ + if (!currentFavorite) return; + + NSDictionary *oldFavorite = [currentFavorite nodeFavorite]; + NSDictionary *newFavorite = [[[self selectedFavoriteNode] representedObject] nodeFavorite]; + + NSString *passwordValue; + NSString *oldKeychainName, *newKeychainName; + NSString *oldKeychainAccount, *newKeychainAccount; + NSString *oldHostnameForPassword = ([[oldFavorite objectForKey:SPFavoriteTypeKey] integerValue] == SPSocketConnection) ? @"localhost" : [oldFavorite objectForKey:SPFavoriteHostKey]; + NSString *newHostnameForPassword = ([[newFavorite objectForKey:SPFavoriteTypeKey] integerValue] == SPSocketConnection) ? @"localhost" : [newFavorite objectForKey:SPFavoriteHostKey]; + + // SQL passwords are indexed by name, host, user and database. If any of these + // have changed, or a standard password field has, alter the keychain item to match. + if (![[oldFavorite objectForKey:SPFavoriteNameKey] isEqualToString:[newFavorite objectForKey:SPFavoriteNameKey]] || + ![oldHostnameForPassword isEqualToString:newHostnameForPassword] || + ![[oldFavorite objectForKey:SPFavoriteUserKey] isEqualToString:[newFavorite objectForKey:SPFavoriteUserKey]] || + ![[oldFavorite objectForKey:SPFavoriteDatabaseKey] isEqualToString:[newFavorite objectForKey:SPFavoriteDatabaseKey]] || + control == standardPasswordField || control == socketPasswordField || control == sshPasswordField) + { + // Determine the correct password field to read the password from, defaulting to standard + if (control == socketPasswordField) { + passwordValue = [socketPasswordField stringValue]; + } + else if (control == sshPasswordField) { + passwordValue = [sshPasswordField stringValue]; + } + else { + passwordValue = [standardPasswordField stringValue]; + } + + // Get the old keychain name and account strings + oldKeychainName = [keychain nameForFavoriteName:[oldFavorite objectForKey:SPFavoriteNameKey] id:[newFavorite objectForKey:SPFavoriteIDKey]]; + oldKeychainAccount = [keychain accountForUser:[oldFavorite objectForKey:SPFavoriteUserKey] host:oldHostnameForPassword database:[oldFavorite objectForKey:SPFavoriteDatabaseKey]]; + + // Delete the old keychain item + [keychain deletePasswordForName:oldKeychainName account:oldKeychainAccount]; + + // Set up the new keychain name and account strings + newKeychainName = [keychain nameForFavoriteName:[newFavorite objectForKey:SPFavoriteNameKey] id:[newFavorite objectForKey:SPFavoriteIDKey]]; + newKeychainAccount = [keychain accountForUser:[newFavorite objectForKey:SPFavoriteUserKey] host:newHostnameForPassword database:[newFavorite objectForKey:SPFavoriteDatabaseKey]]; + + // Add the new keychain item if the password field has a value + if ([passwordValue length]) { + [keychain addPassword:passwordValue forName:newKeychainName account:newKeychainAccount]; + } + + // Synch password changes + [standardPasswordField setStringValue:passwordValue]; + [socketPasswordField setStringValue:passwordValue]; + [sshPasswordField setStringValue:passwordValue]; + + passwordValue = @""; + } + + // If SSH account/password details have changed, update the keychain to match + if (![[oldFavorite objectForKey:SPFavoriteNameKey] isEqualToString:[newFavorite objectForKey:SPFavoriteNameKey]] || + ![[oldFavorite objectForKey:SPFavoriteSSHHostKey] isEqualToString:[newFavorite objectForKey:SPFavoriteSSHHostKey]] || + ![[oldFavorite objectForKey:SPFavoriteSSHUserKey] isEqualToString:[newFavorite objectForKey:SPFavoriteSSHUserKey]] || + control == sshSSHPasswordField) + { + // Get the old keychain name and account strings + oldKeychainName = [keychain nameForSSHForFavoriteName:[oldFavorite objectForKey:SPFavoriteNameKey] id:[newFavorite objectForKey:SPFavoriteIDKey]]; + oldKeychainAccount = [keychain accountForSSHUser:[oldFavorite objectForKey:SPFavoriteSSHUserKey] sshHost:[oldFavorite objectForKey:SPFavoriteSSHHostKey]]; + + // Delete the old keychain item + [keychain deletePasswordForName:oldKeychainName account:oldKeychainAccount]; + + // Set up the new keychain name and account strings + newKeychainName = [keychain nameForSSHForFavoriteName:[newFavorite objectForKey:SPFavoriteNameKey] id:[newFavorite objectForKey:SPFavoriteIDKey]]; + newKeychainAccount = [keychain accountForSSHUser:[newFavorite objectForKey:SPFavoriteSSHUserKey] sshHost:[newFavorite objectForKey:SPFavoriteSSHHostKey]]; + + // Add the new keychain item if the password field has a value + if ([[sshPasswordField stringValue] length]) { + [keychain addPassword:[sshPasswordField stringValue] forName:newKeychainName account:newKeychainAccount]; + } + } + + // Update the current favorite + if (currentFavorite) [currentFavorite release], currentFavorite = nil; + + if ([[favoritesOutlineView selectedRowIndexes] count]) { + currentFavorite = [[[self selectedFavoriteNode] representedObject] copy]; + } +} + +#pragma mark - -- (BOOL)isFlipped +- (void)dealloc { - return YES; + [keychain release]; + [prefs release]; + + [folderImage release], folderImage = nil; + + for (id retainedObject in nibObjectsToRelease) [retainedObject release]; + + [nibObjectsToRelease release]; + + if (mySQLConnection) [mySQLConnection release]; + if (sshTunnel) [sshTunnel setConnectionStateChangeSelector:nil delegate:nil], [sshTunnel disconnect], [sshTunnel release]; + if (connectionKeychainItemName) [connectionKeychainItemName release]; + if (connectionKeychainItemAccount) [connectionKeychainItemAccount release]; + if (connectionSSHKeychainItemName) [connectionSSHKeychainItemName release]; + if (connectionSSHKeychainItemAccount) [connectionSSHKeychainItemAccount release]; + if (currentFavorite) [currentFavorite release], currentFavorite = nil; + + [super dealloc]; } @end |