//
// CustomQuery.m
// sequel-pro
//
// Created by lorenz textor (lorenz@textor.ch) on Wed May 01 2002.
// Copyright (c) 2002-2003 Lorenz Textor. All rights reserved.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// More info at
// Or mail to
#import "CustomQuery.h"
#import "SPSQLParser.h"
#import "SPGrowlController.h"
#import "SPStringAdditions.h"
@implementation CustomQuery
#pragma mark IBAction methods
/*
* Split all the queries in the text view, split them into individual queries,
* and run sequentially.
*/
- (IBAction)runAllQueries:(id)sender
{
SPSQLParser *queryParser;
NSArray *queries;
// Fixes bug in key equivalents.
if ([[NSApp currentEvent] type] == NSKeyUp) {
return;
}
// Retrieve the custom query string and split it into separate SQL queries
queryParser = [[SPSQLParser alloc] initWithString:[textView string]];
queries = [queryParser splitStringByCharacter:';'];
[queryParser release];
NSRange curRange = [textView selectedRange];
// Unselect a selection if given to avoid interferring with error highlighting
[textView setSelectedRange:NSMakeRange(curRange.location, 0)];
// Reset queryStartPosition
queryStartPosition = 0;
[self performQueries:queries];
// If no error was selected reconstruct a given selection
if([textView selectedRange].length == 0)
[textView setSelectedRange:curRange];
// Invoke textStorageDidProcessEditing: for syntax highlighting and auto-uppercase
NSRange oldRange = [textView selectedRange];
[textView setSelectedRange:NSMakeRange(oldRange.location,0)];
[textView insertText:@""];
[textView setSelectedRange:oldRange];
// Select the text of the query textView for re-editing
//[textView selectAll:self];
}
/*
* Depending on selection, run either the query containing the selection caret (if the caret is
* at a single point within the text view), or run the selected text (if a text range is selected).
*/
- (IBAction)runSelectedQueries:(id)sender
{
NSArray *queries;
NSString *query;
NSRange selectedRange = [textView selectedRange];
SPSQLParser *queryParser;
// If the current selection is a single caret position, run the current query.
if (selectedRange.length == 0) {
BOOL doLookBehind = YES;
query = [self queryAtPosition:selectedRange.location lookBehind:&doLookBehind];
if (!query) {
NSBeep();
return;
}
queries = [NSArray arrayWithObject:query];
// Otherwise, run the selected text.
} else {
queryParser = [[SPSQLParser alloc] initWithString:[[textView string] substringWithRange:selectedRange]];
queries = [queryParser splitStringByCharacter:';'];
[queryParser release];
}
// Invoke textStorageDidProcessEditing: for syntax highlighting and auto-uppercase
// and preserve the selection
[textView setSelectedRange:NSMakeRange(selectedRange.location,0)];
[textView insertText:@""];
[textView setSelectedRange:selectedRange];
[self performQueries:queries];
}
- (IBAction)chooseQueryFavorite:(id)sender
/*
insert the choosen favorite query in the query textView or save query to favorites or opens window to edit favorites
*/
{
if ( [queryFavoritesButton indexOfSelectedItem] == 1) {
//save query to favorites
//check if favorite doesn't exist
NSEnumerator *enumerator = [queryFavorites objectEnumerator];
id favorite;
while ( (favorite = [enumerator nextObject]) ) {
if ( [favorite isEqualToString:[textView string]] ) {
NSBeginAlertSheet(NSLocalizedString(@"Error", @"error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, tableWindow, self, nil, nil, nil,
NSLocalizedString(@"Query already exists in favorites.", @"message of panel when trying to save query which already exists in favorites"));
return;
}
}
if ( [[textView string] isEqualToString:@""] ) {
NSBeginAlertSheet(NSLocalizedString(@"Error", @"error"), NSLocalizedString(@"OK", @"OK button"), nil, nil, tableWindow, self, nil, nil, nil,
NSLocalizedString(@"Query can't be empty.", @"message of panel when trying to save empty query"));
return;
}
[queryFavorites addObject:[NSString stringWithString:[textView string]]];
[queryFavoritesView reloadData];
[prefs setObject:queryFavorites forKey:@"queryFavorites"];
[self setFavorites];
} else if ( [queryFavoritesButton indexOfSelectedItem] == 2) {
//edit favorites
[NSApp beginSheet:queryFavoritesSheet
modalForWindow:tableWindow modalDelegate:self
didEndSelector:nil contextInfo:nil];
[NSApp runModalForWindow:queryFavoritesSheet];
[NSApp endSheet:queryFavoritesSheet];
[queryFavoritesSheet orderOut:nil];
} else if ( [queryFavoritesButton indexOfSelectedItem] != 3) {
//choose favorite
// Register the next action for undo
[textView shouldChangeTextInRange:[textView selectedRange] replacementString:[queryFavoritesButton titleOfSelectedItem]];
[textView replaceCharactersInRange:[textView selectedRange] withString:[queryFavoritesButton titleOfSelectedItem]];
// invoke textStorageDidProcessEditing: for syntax highlighting and auto-uppercase
[textView insertText:@""];
}
}
- (IBAction)chooseQueryHistory:(id)sender
/*
insert the choosen history query in the query textView
*/
{
// Register the next action for undo
[textView shouldChangeTextInRange:NSMakeRange(0,[[textView string] length]) replacementString:[queryHistoryButton titleOfSelectedItem]];
[textView setString:[queryHistoryButton titleOfSelectedItem]];
// Invoke textStorageDidProcessEditing: for syntax highlighting and auto-uppercase
[textView insertText:@""];
[textView selectAll:self];
}
- (IBAction)closeSheet:(id)sender
/*
closes the sheet
*/
{
[NSApp stopModal];
}
/*
* Perform simple actions (which don't require their own method), triggered by selecting the appropriate menu item
* in the "gear" action menu displayed beneath the cusotm query view.
*/
- (IBAction)gearMenuItemSelected:(id)sender
{
// "Clear History" menu item - clear query history
if (sender == clearHistoryMenuItem) {
[queryHistoryButton removeAllItems];
[queryHistoryButton addItemWithTitle:NSLocalizedString(@"Query History…",@"Title of query history popup button")];
[prefs setObject:[NSArray array] forKey:@"queryHistory"];
}
// "Shift Right" menu item - indent the selection with an additional tab.
if (sender == shiftRightMenuItem) {
[textView shiftSelectionRight];
}
// "Shift Left" menu item - un-indent the selection by one tab if possible.
if (sender == shiftLeftMenuItem) {
[textView shiftSelectionLeft];
}
// "Completion List" menu item - used to autocomplete. Uses a different shortcut to avoid the menu button flickering
// on normal autocomplete usage.
if (sender == completionListMenuItem) {
[textView complete:self];
}
// "Editor font..." menu item to bring up the font panel
if (sender == editorFontMenuItem) {
[[NSFontPanel sharedFontPanel] setPanelFont:[textView font] isMultiple:NO];
[[NSFontPanel sharedFontPanel] makeKeyAndOrderFront:self];
}
// "Indent new lines" toggle
if (sender == autoindentMenuItem) {
BOOL enableAutoindent = ([autoindentMenuItem state] == NSOffState);
[prefs setBool:enableAutoindent forKey:@"CustomQueryAutoindent"];
[prefs synchronize];
[autoindentMenuItem setState:enableAutoindent?NSOnState:NSOffState];
[textView setAutoindent:enableAutoindent];
}
// "Auto-pair characters" toggle
if (sender == autopairMenuItem) {
BOOL enableAutopair = ([autopairMenuItem state] == NSOffState);
[prefs setBool:enableAutopair forKey:@"CustomQueryAutopair"];
[prefs synchronize];
[autopairMenuItem setState:enableAutopair?NSOnState:NSOffState];
[textView setAutopair:enableAutopair];
}
// "Auto-uppercase keywords" toggle
if (sender == autouppercaseKeywordsMenuItem) {
BOOL enableAutouppercaseKeywords = ([autouppercaseKeywordsMenuItem state] == NSOffState);
[prefs setBool:enableAutouppercaseKeywords forKey:@"CustomQueryAutouppercaseKeywords"];
[prefs synchronize];
[autouppercaseKeywordsMenuItem setState:enableAutouppercaseKeywords?NSOnState:NSOffState];
[textView setAutouppercaseKeywords:enableAutouppercaseKeywords];
}
}
#pragma mark -
#pragma mark queryFavoritesSheet methods
- (IBAction)addQueryFavorite:(id)sender
/*
adds a query favorite
*/
{
int row = [queryFavoritesView editedRow];
int column = [queryFavoritesView editedColumn];
NSTableColumn *tableColumn;
NSCell *cell;
//end editing
if ( row != -1 ) {
tableColumn = [[queryFavoritesView tableColumns] objectAtIndex:column];
cell = [tableColumn dataCellForRow:row];
[cell endEditing:[queryFavoritesView currentEditor]];
}
[queryFavorites addObject:[NSString string]];
[queryFavoritesView reloadData];
[queryFavoritesView selectRow:[queryFavoritesView numberOfRows]-1 byExtendingSelection:NO];
[queryFavoritesView editColumn:0 row:[queryFavoritesView numberOfRows]-1 withEvent:nil select:YES];
}
- (IBAction)removeQueryFavorite:(id)sender
/*
removes a query favorite
*/
{
int row = [queryFavoritesView editedRow];
int column = [queryFavoritesView editedColumn];
NSTableColumn *tableColumn;
NSCell *cell;
//end editing
if ( row != -1 ) {
tableColumn = [[queryFavoritesView tableColumns] objectAtIndex:column];
cell = [tableColumn dataCellForRow:row];
[cell endEditing:[queryFavoritesView currentEditor]];
}
if ( [queryFavoritesView numberOfSelectedRows] > 0 ) {
[queryFavorites removeObjectAtIndex:[queryFavoritesView selectedRow]];
[queryFavoritesView reloadData];
}
}
- (IBAction)copyQueryFavorite:(id)sender
/*
copies a query favorite
*/
{
int row = [queryFavoritesView editedRow];
int column = [queryFavoritesView editedColumn];
NSTableColumn *tableColumn;
NSCell *cell;
//end editing
if ( row != -1 ) {
tableColumn = [[queryFavoritesView tableColumns] objectAtIndex:column];
cell = [tableColumn dataCellForRow:row];
[cell endEditing:[queryFavoritesView currentEditor]];
}
if ( [queryFavoritesView numberOfSelectedRows] > 0 ) {
[queryFavorites insertObject:
[NSString stringWithString:[queryFavorites objectAtIndex:[queryFavoritesView selectedRow]]]
atIndex:[queryFavoritesView selectedRow]+1];
[queryFavoritesView reloadData];
[queryFavoritesView selectRow:[queryFavoritesView selectedRow]+1 byExtendingSelection:NO];
[queryFavoritesView editColumn:0 row:[queryFavoritesView selectedRow] withEvent:nil select:YES];
}
}
- (IBAction)closeQueryFavoritesSheet:(id)sender
/*
closes queryFavoritesSheet and saves favorites to preferences
*/
{
int row = [queryFavoritesView editedRow];
int column = [queryFavoritesView editedColumn];
NSTableColumn *tableColumn;
NSCell *cell;
//end editing
if ( row != -1 ) {
tableColumn = [[queryFavoritesView tableColumns] objectAtIndex:column];
cell = [tableColumn dataCellForRow:row];
[cell endEditing:[queryFavoritesView currentEditor]];
}
[NSApp stopModal];
[prefs setObject:queryFavorites forKey:@"queryFavorites"];
[self setFavorites];
}
#pragma mark -
#pragma mark Query actions
- (void)performQueries:(NSArray *)queries;
/*
performs the mysql-query given by the user
sets the tableView columns corresponding to the mysql-result
*/
{
NSArray *theColumns;
NSTableColumn *theCol;
CMMCPResult *theResult = nil;
NSMutableArray *menuItems = [NSMutableArray array];
NSMutableArray *tempResult = [NSMutableArray array];
NSMutableString *errors = [NSMutableString string];
int i, totalQueriesRun = 0, totalAffectedRows = 0;
float executionTime = 0;
int firstErrorOccuredInQuery = -1;
BOOL suppressErrorSheet = NO;
// Notify listeners that a query has started
[[NSNotificationCenter defaultCenter] postNotificationName:@"SMySQLQueryWillBePerformed" object:self];
// Reset the current table view as necessary to avoid redraw and reload issues.
// Restore the view position to the top left to be within the results for all datasets.
[customQueryView scrollRowToVisible:0];
[customQueryView scrollColumnToVisible:0];
// Remove all the columns
theColumns = [customQueryView tableColumns];
while ([theColumns count]) {
[customQueryView removeTableColumn:[theColumns objectAtIndex:0]];
}
// Perform the supplied queries in series
for ( i = 0 ; i < [queries count] ; i++ ) {
// Don't run blank queries, or queries which only contain whitespace.
if ([[[queries objectAtIndex:i] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] length] == 0)
continue;
// Run the query, timing execution (note this also includes network and overhead)
theResult = [mySQLConnection queryString:[queries objectAtIndex:i]];
executionTime += [mySQLConnection lastQueryExecutionTime];
totalQueriesRun++;
// Record any affected rows
if ( [mySQLConnection affectedRows] != -1 )
totalAffectedRows += [mySQLConnection affectedRows];
// Store any error messages
if ( ![[mySQLConnection getLastErrorMessage] isEqualToString:@""] ) {
// If the query errored, append error to the error log for display at the end
if ( [queries count] > 1 ) {
if(firstErrorOccuredInQuery == -1)
firstErrorOccuredInQuery = i+1;
if(!suppressErrorSheet)
{
// Update error text for the user
[errors appendString:[NSString stringWithFormat:NSLocalizedString(@"[ERROR in query %d] %@\n", @"error text when multiple custom query failed"),
i+1,
[mySQLConnection getLastErrorMessage]]];
[errorText setStringValue:errors];
// ask the user to continue after detecting an error
NSAlert *alert = [[[NSAlert alloc] init] autorelease];
[alert addButtonWithTitle:NSLocalizedString(@"Run All", @"run all button")];
[alert addButtonWithTitle:NSLocalizedString(@"Continue", @"continue button")];
[alert addButtonWithTitle:NSLocalizedString(@"Stop", @"stop button")];
[alert setMessageText:NSLocalizedString(@"MySQL Error", @"mysql error message")];
[alert setInformativeText:[mySQLConnection getLastErrorMessage]];
[alert setAlertStyle:NSWarningAlertStyle];
int choice = [alert runModal];
switch (choice){
case NSAlertFirstButtonReturn:
suppressErrorSheet = YES;
case NSAlertSecondButtonReturn:
break;
default:
if(i < [queries count]-1) // output that message only if it was not the last one
[errors appendString:NSLocalizedString(@"Execution stopped!\n", @"execution stopped message")];
i = [queries count]; // break for loop; for safety reasons stop the execution of the following queries
}
} else {
[errors appendString:[NSString stringWithFormat:NSLocalizedString(@"[ERROR in query %d] %@\n", @"error text when multiple custom query failed"),
i+1,
[mySQLConnection getLastErrorMessage]]];
}
} else {
[errors setString:[mySQLConnection getLastErrorMessage]];
}
}
}
if(usedQuery)
[usedQuery release];
usedQuery = [[NSString stringWithString:[queries componentsJoinedByString:@";\n"]] retain];
//perform empty query if no query is given
if ( [queries count] == 0 ) {
theResult = [mySQLConnection queryString:@""];
[errors setString:[mySQLConnection getLastErrorMessage]];
}
//put result in array
[queryResult release];
queryResult = nil;
if ( nil != theResult )
{
int r = [theResult numOfRows];
if (r) [theResult dataSeek:0];
for ( i = 0 ; i < r ; i++ ) {
[tempResult addObject:[theResult fetchRowAsArray]];
}
queryResult = [[NSArray arrayWithArray:tempResult] retain];
}
//add query to history
[queryHistoryButton insertItemWithTitle:[queries componentsJoinedByString:@"; "] atIndex:1];
while ( [queryHistoryButton numberOfItems] > [[prefs objectForKey:@"CustomQueryMaxHistoryItems"] intValue] + 1 ) {
[queryHistoryButton removeItemAtIndex:[queryHistoryButton numberOfItems]-1];
}
for ( i = 1 ; i < [queryHistoryButton numberOfItems] ; i++ )
{
[menuItems addObject:[queryHistoryButton itemTitleAtIndex:i]];
}
[prefs setObject:menuItems forKey:@"queryHistory"];
// Error checking
if ( [errors length] ) {
// set the error text
[errorText setStringValue:errors];
// select the line x of the first error if error message contains "at line x"
NSError *err1 = NULL;
NSRange errorLineNumberRange = [errors rangeOfRegex:@"([0-9]+)$" options:RKLNoOptions inRange:NSMakeRange(0, [errors length]) capture:1 error:&err1];
if(errorLineNumberRange.length) // if a line number was found
{
// Get the line number
unsigned int errorAtLine = [[errors substringWithRange:errorLineNumberRange] intValue];
[textView selectLineNumber:errorAtLine ignoreLeadingNewLines:YES];
// Check for near message
NSRange errorNearMessageRange = [errors rangeOfRegex:@" '(.*?)' " options:(RKLMultiline|RKLDotAll) inRange:NSMakeRange(0, [errors length]) capture:1 error:&err1];
if(errorNearMessageRange.length) // if a "near message" was found
{
// Build the range to search for nearMessage (beginning from queryStartPosition to try to avoid mismatching)
NSRange theRange = NSMakeRange(queryStartPosition, [[textView string] length]-queryStartPosition);
// Get the range in textView of the near message
NSRange textNearMessageRange = [[[textView string] substringWithRange:theRange] rangeOfString:[errors substringWithRange:errorNearMessageRange] options:NSLiteralSearch];
// Correct the near message range relative to queryStartPosition
textNearMessageRange = NSMakeRange(textNearMessageRange.location+queryStartPosition, textNearMessageRange.length);
// Select the near message and scroll to it
[textView setSelectedRange:textNearMessageRange];
[textView scrollRangeToVisible:textNearMessageRange];
}
} else { // Select first erroneous query entirely
NSRange queryRange;
if(firstErrorOccuredInQuery == -1) // for current or previous query
{
BOOL isLookBehind = YES;
queryRange = [self queryTextRangeAtPosition:[textView selectedRange].location lookBehind:&isLookBehind];
[textView setSelectedRange:queryRange];
} else {
// select the query for which the first error was detected
queryRange = [self queryTextRangeForQuery:firstErrorOccuredInQuery startPosition:queryStartPosition];
[textView setSelectedRange:queryRange];
}
}
} else {
[errorText setStringValue:NSLocalizedString(@"There were no errors.", @"text shown when query was successfull")];
}
// Set up the status string
if ( totalQueriesRun > 1 ) {
if (totalAffectedRows==1) {
[affectedRowsText setStringValue:[NSString stringWithFormat:NSLocalizedString(@"1 row affected in total, by %i queries taking %@", @"text showing one row has been affected by multiple queries"),
totalQueriesRun,
[NSString stringForTimeInterval:executionTime]
]];
} else {
[affectedRowsText setStringValue:[NSString stringWithFormat:NSLocalizedString(@"%i rows affected in total, by %i queries taking %@", @"text showing how many rows have been affected by multiple queries"),
totalAffectedRows,
totalQueriesRun,
[NSString stringForTimeInterval:executionTime]
]];
}
} else {
if (totalAffectedRows==1) {
[affectedRowsText setStringValue:[NSString stringWithFormat:NSLocalizedString(@"1 row affected, taking %@", @"text showing one row has been affected by a single query"),
[NSString stringForTimeInterval:executionTime]
]];
} else {
[affectedRowsText setStringValue:[NSString stringWithFormat:NSLocalizedString(@"%i rows affected, taking %@", @"text showing how many rows have been affected by a single query"),
totalAffectedRows,
[NSString stringForTimeInterval:executionTime]
]];
}
}
// If no results were returned, redraw the empty table and post notifications before returning.
if ( !theResult || ![theResult numOfRows] ) {
[customQueryView reloadData];
// Notify any listeners that the query has completed
[[NSNotificationCenter defaultCenter] postNotificationName:@"SMySQLQueryHasBeenPerformed" object:self];
// Perform the Growl notification for query completion
[[SPGrowlController sharedGrowlController] notifyWithTitle:@"Query Finished"
description:[NSString stringWithFormat:NSLocalizedString(@"%@",@"description for query finished growl notification"), [errorText stringValue]]
notificationName:@"Query Finished"];
return;
}
// Otherwise add columns corresponding to the query result
theColumns = [theResult fetchFieldNames];
for ( i = 0 ; i < [theResult numOfFields] ; i++) {
theCol = [[NSTableColumn alloc] initWithIdentifier:[NSNumber numberWithInt:i]];
[theCol setResizingMask:NSTableColumnUserResizingMask];
NSTextFieldCell *dataCell = [[[NSTextFieldCell alloc] initTextCell:@""] autorelease];
[dataCell setEditable:NO];
if ( [prefs boolForKey:@"UseMonospacedFonts"] ) {
[dataCell setFont:[NSFont fontWithName:@"Monaco" size:10]];
} else {
[dataCell setFont:[NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
}
[dataCell setLineBreakMode:NSLineBreakByTruncatingTail];
[theCol setDataCell:dataCell];
[[theCol headerCell] setStringValue:[theColumns objectAtIndex:i]];
[customQueryView addTableColumn:theCol];
[theCol release];
}
[customQueryView sizeLastColumnToFit];
//tries to fix problem with last row (otherwise to small)
//sets last column to width of the first if smaller than 30
//problem not fixed for resizing window
if ( [[customQueryView tableColumnWithIdentifier:[NSNumber numberWithInt:[theColumns count]-1]] width] < 30 )
[[customQueryView tableColumnWithIdentifier:[NSNumber numberWithInt:[theColumns count]-1]]
setWidth:[[customQueryView tableColumnWithIdentifier:[NSNumber numberWithInt:0]] width]];
[customQueryView reloadData];
//query finished
[[NSNotificationCenter defaultCenter] postNotificationName:@"SMySQLQueryHasBeenPerformed" object:self];
// Query finished Growl notification
[[SPGrowlController sharedGrowlController] notifyWithTitle:@"Query Finished"
description:[NSString stringWithFormat:NSLocalizedString(@"%@",@"description for query finished growl notification"), [errorText stringValue]]
notificationName:@"Query Finished"];
}
/*
* Retrieve the range of the query at a position specified
* within the custom query text view.
*/
- (NSRange)queryTextRangeAtPosition:(long)position lookBehind:(BOOL *)doLookBehind
{
SPSQLParser *customQueryParser;
NSArray *queries;
NSString *query = nil;
int i, lastQueryStartPosition, queryPosition = 0;
// If the supplied position is negative or beyond the end of the string, return nil.
if (position < 0 || position > [[textView string] length])
return NSMakeRange(NSNotFound,0);
// Split the current text into queries
customQueryParser = [[SPSQLParser alloc] initWithString:[textView string]];
queries = [[NSArray alloc] initWithArray:[customQueryParser splitStringByCharacter:';']];
[customQueryParser release];
// Walk along the array of queries to identify the current query - taking into account
// the extra semicolon at the end of each query
for (i = 0; i < [queries count]; i++ ) {
lastQueryStartPosition = queryStartPosition;
queryStartPosition = queryPosition;
queryPosition += [[queries objectAtIndex:i] length];
if (queryPosition >= position) {
// If lookbehind is enabled, determine whether it's valid and check
// if after the caret position are only white spaces or newlines
if (*doLookBehind) {
NSCharacterSet *trimSet = [NSCharacterSet whitespaceAndNewlineCharacterSet];
NSString *string = [textView string];
unsigned int curCaretPosition = [textView selectedRange].location;
NSRange curlineRange = [string lineRangeForRange:NSMakeRange(curCaretPosition, 0)];
NSString *lineTailFromCaret = [[string substringWithRange:
NSMakeRange([textView selectedRange].location,
curlineRange.length + curlineRange.location - curCaretPosition)] stringByTrimmingCharactersInSet:trimSet];
if (i
&&
![[[string substringWithRange:
NSMakeRange(queryStartPosition, position - queryStartPosition)] stringByTrimmingCharactersInSet:trimSet] length]
&&
![lineTailFromCaret length]
)
{
query = [NSString stringWithString:[queries objectAtIndex:i-1]];
queryStartPosition = lastQueryStartPosition;
break;
}
*doLookBehind = NO;
}
query = [NSString stringWithString:[queries objectAtIndex:i]];
break;
}
queryPosition++;
}
if (doLookBehind && position == [[textView string] length] && !query)
{
query = [queries lastObject];
}
if(queryStartPosition < 0) queryStartPosition = 0;
[queries release];
// Remove all leading white spaces
NSError *err;
int offset = [query rangeOfRegex:@"^(\\s*)" options:RKLNoOptions inRange:NSMakeRange(0, [query length]) capture:1 error:&err].length;
return NSMakeRange(queryStartPosition+offset, [query length]-offset);
}
/*
* Retrieve the range of the query for the passed index seen from a start position
* specified within the custom query text view.
*/
- (NSRange)queryTextRangeForQuery:(int)anIndex startPosition:(long)position
{
SPSQLParser *customQueryParser;
NSArray *queries;
int i;
// If the supplied position is negative or beyond the end of the string, return nil.
if (position < 0 || position > [[textView string] length])
return NSMakeRange(NSNotFound,0);
// Split the current text into queries
customQueryParser = [[SPSQLParser alloc] initWithString:[[textView string] substringWithRange:NSMakeRange(position, [[textView string] length]-position)]];
queries = [[NSArray alloc] initWithArray:[customQueryParser splitStringByCharacter:';']];
[customQueryParser release];
anIndex--;
if(anIndex < 0 || anIndex >= [queries count])
{
[queries release];
return NSMakeRange(NSNotFound, 0);
}
NSString * theQuery = [queries objectAtIndex:anIndex];
// Calculate the text length before that query at index anIndex
long prevQueriesLength = 0;
for (i = 0; i < anIndex; i++ ) {
prevQueriesLength += [[queries objectAtIndex:i] length] + 1;
}
[queries release];
// Remove all leading white spaces
NSError *err;
int offset = [theQuery rangeOfRegex:@"^(\\s*)" options:RKLNoOptions inRange:NSMakeRange(0, [theQuery length]) capture:1 error:&err].length;
return NSMakeRange(position+offset+prevQueriesLength, [theQuery length] - offset);
}
/*
* Retrieve the query at a position specified within the custom query
* text view. This will return nil if the position specified is beyond
* the available string or if an empty query would be returned.
* If lookBehind is set, returns the *previous* query, but only if the
* caret is after a query ending in a semicolon, on the same line, and
* separated only by whitespace.
*/
- (NSString *)queryAtPosition:(long)position lookBehind:(BOOL *)doLookBehind
{
SPSQLParser *customQueryParser;
NSArray *queries;
NSString *query = nil;
int i, lastQueryStartPosition, queryPosition = 0;
// If the supplied position is negative or beyond the end of the string, return nil.
if (position < 0 || position > [[textView string] length])
return nil;
// Split the current text into queries
customQueryParser = [[SPSQLParser alloc] initWithString:[textView string]];
queries = [[NSArray alloc] initWithArray:[customQueryParser splitStringByCharacter:';']];
[customQueryParser release];
// Walk along the array of queries to identify the current query - taking into account
// the extra semicolon at the end of each query
for (i = 0; i < [queries count]; i++ ) {
lastQueryStartPosition = queryStartPosition;
queryStartPosition = queryPosition;
queryPosition += [[queries objectAtIndex:i] length];
if (queryPosition >= position) {
// If lookbehind is enabled, determine whether it's valid and check
// if after the caret position are only white spaces or newlines
if (*doLookBehind) {
NSCharacterSet *trimSet = [NSCharacterSet whitespaceAndNewlineCharacterSet];
NSString *string = [textView string];
unsigned int curCaretPosition = [textView selectedRange].location;
NSRange curlineRange = [string lineRangeForRange:NSMakeRange(curCaretPosition, 0)];
NSString *lineTailFromCaret = [[string substringWithRange:
NSMakeRange([textView selectedRange].location,
curlineRange.length + curlineRange.location - curCaretPosition)] stringByTrimmingCharactersInSet:trimSet];
if (i
&&
![[[string substringWithRange:
NSMakeRange(queryStartPosition, position - queryStartPosition)] stringByTrimmingCharactersInSet:trimSet] length]
&&
![lineTailFromCaret length]
)
{
query = [NSString stringWithString:[queries objectAtIndex:i-1]];
queryStartPosition = lastQueryStartPosition;
break;
}
*doLookBehind = NO;
}
query = [NSString stringWithString:[queries objectAtIndex:i]];
break;
}
queryPosition++;
}
if (doLookBehind && position == [[textView string] length] && !query)
{
query = [queries lastObject];
}
if(queryStartPosition < 0) queryStartPosition = 0;
[queries release];
// Ensure the string isn't empty.
// (We could also strip comments for this check, but that prevents use of conditional comments)
if ([[query stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] length] == 0)
return nil;
// Return the located string.
return query;
}
#pragma mark -
#pragma mark Accessors
- (NSArray *)currentResult
/*
returns the current result (as shown in custom result view) as array, the first object containing the field names as array, the following objects containing the rows as array
*/
{
NSArray *tableColumns = [customQueryView tableColumns];
NSEnumerator *enumerator = [tableColumns objectEnumerator];
id tableColumn;
NSMutableArray *currentResult = [NSMutableArray array];
NSMutableArray *tempRow = [NSMutableArray array];
int i;
//set field names as first line
while ( (tableColumn = [enumerator nextObject]) ) {
[tempRow addObject:[[tableColumn headerCell] stringValue]];
}
[currentResult addObject:[NSArray arrayWithArray:tempRow]];
//add rows
for ( i = 0 ; i < [self numberOfRowsInTableView:customQueryView] ; i++) {
[tempRow removeAllObjects];
enumerator = [tableColumns objectEnumerator];
while ( (tableColumn = [enumerator nextObject]) ) {
[tempRow addObject:[self tableView:customQueryView objectValueForTableColumn:tableColumn row:i]];
}
[currentResult addObject:[NSArray arrayWithArray:tempRow]];
}
return currentResult;
}
#pragma mark -
#pragma mark Additional methods
- (void)setConnection:(CMMCPConnection *)theConnection
/*
sets the connection (received from TableDocument) and makes things that have to be done only once
*/
{
NSArray *tableColumns = [queryFavoritesView tableColumns];
NSEnumerator *enumerator = [tableColumns objectEnumerator];
id column;
mySQLConnection = theConnection;
prefs = [[NSUserDefaults standardUserDefaults] retain];
if ( [prefs objectForKey:@"queryFavorites"] ) {
queryFavorites = [[NSMutableArray alloc] initWithArray:[prefs objectForKey:@"queryFavorites"]];
} else {
queryFavorites = [[NSMutableArray array] retain];
}
// Set up the interface
[customQueryView setVerticalMotionCanBeginDrag:NO];
[textView setFont:[NSUnarchiver unarchiveObjectWithData:[prefs dataForKey:@"CustomQueryEditorFont"]]];
[textView setContinuousSpellCheckingEnabled:NO];
[autoindentMenuItem setState:([prefs boolForKey:@"CustomQueryAutoindent"]?NSOnState:NSOffState)];
[textView setAutoindent:[prefs boolForKey:@"CustomQueryAutoindent"]];
[textView setAutoindentIgnoresEnter:YES];
[autopairMenuItem setState:([prefs boolForKey:@"CustomQueryAutopair"]?NSOnState:NSOffState)];
[textView setAutopair:[prefs boolForKey:@"CustomQueryAutopair"]];
[autouppercaseKeywordsMenuItem setState:([prefs boolForKey:@"CustomQueryAutouppercaseKeywords"]?NSOnState:NSOffState)];
[textView setAutouppercaseKeywords:[prefs boolForKey:@"CustomQueryAutouppercaseKeywords"]];
[queryFavoritesView registerForDraggedTypes:[NSArray arrayWithObjects:@"SequelProPasteboard", nil]];
while ( (column = [enumerator nextObject]) )
{
if ( [prefs boolForKey:@"UseMonospacedFonts"] ) {
[[column dataCell] setFont:[NSFont fontWithName:@"Monaco" size:10]];
} else {
[[column dataCell] setFont:[NSFont systemFontOfSize:[NSFont smallSystemFontSize]]];
}
}
if ( [prefs objectForKey:@"queryHistory"] )
{
[queryHistoryButton addItemsWithTitles:[prefs objectForKey:@"queryHistory"]];
}
[self setFavorites];
// To be able to disable runSelectionMenuItem
[[runSelectionMenuItem menu] setAutoenablesItems:NO];
// Disable runSelectionMenuItem in the gear menu
[runSelectionMenuItem setEnabled:NO];
}
- (void)setFavorites
/*
set up the favorites popUpButton
*/
{
int i;
//remove all menuItems and add favorites from preferences
for ( i = 4 ; i < [queryFavoritesButton numberOfItems] ; i++ ) {
[queryFavoritesButton removeItemAtIndex:i];
}
[queryFavoritesButton addItemsWithTitles:queryFavorites];
}
- (void)doPerformQueryService:(NSString *)query
/*
inserts the query in the textView and performs query
*/
{
[textView setString:query];
[self runAllQueries:self];
}
- (NSString *)usedQuery
{
return usedQuery;
}
#pragma mark -
#pragma mark TableView datasource methods
- (int)numberOfRowsInTableView:(NSTableView *)aTableView
{
if ( aTableView == customQueryView ) {
if ( nil == queryResult ) {
return 0;
} else {
return [queryResult count];
}
} else if ( aTableView == queryFavoritesView ) {
return [queryFavorites count];
} else {
return 0;
}
}
- (id)tableView:(NSTableView *)aTableView
objectValueForTableColumn:(NSTableColumn *)aTableColumn
row:(int)rowIndex
{
NSArray *theRow;
NSNumber *theIdentifier = [aTableColumn identifier];
if ( aTableView == customQueryView ) {
theRow = [queryResult objectAtIndex:rowIndex];
if ( [[theRow objectAtIndex:[theIdentifier intValue]] isKindOfClass:[NSData class]] ) {
NSString *tmp = [[NSString alloc] initWithData:[theRow objectAtIndex:[theIdentifier intValue]]
encoding:[mySQLConnection encoding]];
if (tmp == nil) {
tmp = [[NSString alloc] initWithData:[theRow objectAtIndex:[theIdentifier intValue]]
encoding:NSASCIIStringEncoding];
}
return [tmp autorelease];
}
if ( [[theRow objectAtIndex:[theIdentifier intValue]] isMemberOfClass:[NSNull class]] )
return [prefs objectForKey:@"NullValue"];
return [theRow objectAtIndex:[theIdentifier intValue]];
} else if ( aTableView == queryFavoritesView ) {
return [queryFavorites objectAtIndex:rowIndex];
} else {
return @"";
}
}
- (void)tableView:(NSTableView *)aTableView setObjectValue:(id)anObject
forTableColumn:(NSTableColumn *)aTableColumn row:(int)rowIndex
{
if ( aTableView == queryFavoritesView ) {
NSEnumerator *enumerator = [queryFavorites objectEnumerator];
id favorite;
int i = 0;
if ( [anObject isEqualToString:@""] ) {
[queryFavoritesView deselectAll:self];
[queryFavorites removeObjectAtIndex:rowIndex];
[queryFavoritesView reloadData];
return;
}
while ( (favorite = [enumerator nextObject]) ) {
if ( [favorite isEqualToString:anObject] && i != rowIndex) {
NSRunAlertPanel(@"Error", @"Query already exists in favorites.", @"OK", nil, nil);
//remove row if it was a (blank) new row or a copied row
if ( [[queryFavorites objectAtIndex:rowIndex] isEqualToString:@""] ||
[[queryFavorites objectAtIndex:rowIndex] isEqualToString:anObject] ) {
[queryFavoritesView deselectAll:self];
[queryFavorites removeObjectAtIndex:rowIndex];
[queryFavoritesView reloadData];
}
return;
}
i++;
}
[queryFavorites replaceObjectAtIndex:rowIndex withObject:anObject];
[queryFavoritesView reloadData];
}
}
//tableView drag&drop datasource methods
- (BOOL)tableView:(NSTableView *)aTableView writeRows:(NSArray*)rows toPasteboard:(NSPasteboard*)pboard
{
int originalRow;
NSArray *pboardTypes;
if ( aTableView == queryFavoritesView )
{
if ( [rows count] == 1 )
{
pboardTypes = [NSArray arrayWithObjects:@"SequelProPasteboard", nil];
originalRow = [[rows objectAtIndex:0] intValue];
[pboard declareTypes:pboardTypes owner:nil];
[pboard setString:[[NSNumber numberWithInt:originalRow] stringValue] forType:@"SequelProPasteboard"];
return YES;
}
else
{
return NO;
}
} else if ( aTableView == customQueryView ) {
NSString *tmp = [customQueryView draggedRowsAsTabString:rows];
if ( nil != tmp )
{
[pboard declareTypes:[NSArray arrayWithObjects: NSTabularTextPboardType,
NSStringPboardType, nil]
owner:nil];
[pboard setString:tmp forType:NSStringPboardType];
[pboard setString:tmp forType:NSTabularTextPboardType];
return YES;
}
return NO;
} else {
return NO;
}
}
- (NSDragOperation)tableView:(NSTableView*)aTableView validateDrop:(id )info proposedRow:(int)row
proposedDropOperation:(NSTableViewDropOperation)operation
{
NSArray *pboardTypes = [[info draggingPasteboard] types];
int originalRow;
if ( aTableView == queryFavoritesView ) {
if ([pboardTypes count] == 1 && row != -1)
{
if ([[pboardTypes objectAtIndex:0] isEqualToString:@"SequelProPasteboard"]==YES && operation==NSTableViewDropAbove)
{
originalRow = [[[info draggingPasteboard] stringForType:@"SequelProPasteboard"] intValue];
if (row != originalRow && row != (originalRow+1))
{
return NSDragOperationMove;
}
}
}
return NSDragOperationNone;
} else {
return NSDragOperationNone;
}
}
- (BOOL)tableView:(NSTableView*)aTableView acceptDrop:(id )info row:(int)row dropOperation:(NSTableViewDropOperation)operation
{
int originalRow;
int destinationRow;
NSMutableDictionary *draggedRow;
if ( aTableView == queryFavoritesView ) {
originalRow = [[[info draggingPasteboard] stringForType:@"SequelProPasteboard"] intValue];
destinationRow = row;
if ( destinationRow > originalRow )
destinationRow--;
draggedRow = [queryFavorites objectAtIndex:originalRow];
[queryFavorites removeObjectAtIndex:originalRow];
[queryFavorites insertObject:draggedRow atIndex:destinationRow];
[queryFavoritesView reloadData];
[queryFavoritesView selectRow:destinationRow byExtendingSelection:NO];
return YES;
} else {
return NO;
}
}
//tableView delegate methods
- (BOOL)tableView:(NSTableView *)aTableView shouldEditTableColumn:(NSTableColumn *)aTableColumn row:(int)rowIndex
/*
opens sheet with value when double clicking on a field
*/
{
if ( aTableView == customQueryView ) {
NSArray *theRow;
NSString *theValue;
NSNumber *theIdentifier = [aTableColumn identifier];
//get the value
theRow = [queryResult objectAtIndex:rowIndex];
if ( [[theRow objectAtIndex:[theIdentifier intValue]] isKindOfClass:[NSData class]] ) {
theValue = [[NSString alloc] initWithData:[theRow objectAtIndex:[theIdentifier intValue]]
encoding:[mySQLConnection encoding]];
if (theValue == nil) {
theValue = [[NSString alloc] initWithData:[theRow objectAtIndex:[theIdentifier intValue]]
encoding:NSASCIIStringEncoding];
}
[theValue autorelease];
} else if ( [[theRow objectAtIndex:[theIdentifier intValue]] isMemberOfClass:[NSNull class]] ) {
theValue = [prefs objectForKey:@"NullValue"];
} else {
theValue = [theRow objectAtIndex:[theIdentifier intValue]];
}
[valueTextField setString:[theValue description]];
[valueTextField selectAll:self];
[NSApp beginSheet:valueSheet
modalForWindow:tableWindow modalDelegate:self
didEndSelector:nil contextInfo:nil];
[NSApp runModalForWindow:valueSheet];
[NSApp endSheet:valueSheet];
[valueSheet orderOut:nil];
return NO;
} else {
return YES;
}
}
#pragma mark -
#pragma mark SplitView delegate methods
- (BOOL)splitView:(NSSplitView *)sender canCollapseSubview:(NSView *)subview
/*
tells the splitView that it can collapse views
*/
{
return YES;
}
- (float)splitView:(NSSplitView *)sender constrainMaxCoordinate:(float)proposedMax ofSubviewAt:(int)offset
/*
defines max position of splitView
*/
{
if ( offset == 0 ) {
return proposedMax - 100;
} else {
return proposedMax - 73;
}
}
- (float)splitView:(NSSplitView *)sender constrainMinCoordinate:(float)proposedMin ofSubviewAt:(int)offset
/*
defines min position of splitView
*/
{
if ( offset == 0 ) {
return proposedMin + 100;
} else {
return proposedMin + 100;
}
}
#pragma mark -
#pragma mark TextView delegate methods
- (BOOL)textView:(NSTextView *)aTextView doCommandBySelector:(SEL)aSelector
/*
traps enter key and
performs query instead of inserting a line break if aTextView == textView
closes valueSheet if aTextView == valueTextField
*/
{
if ( aTextView == textView ) {
if ( [aTextView methodForSelector:aSelector] == [aTextView methodForSelector:@selector(insertNewline:)] &&
[[[NSApp currentEvent] characters] isEqualToString:@"\003"] )
{
[self runAllQueries:self];
return YES;
} else {
return NO;
}
} else if ( aTextView == valueTextField ) {
if ( [aTextView methodForSelector:aSelector] == [aTextView methodForSelector:@selector(insertNewline:)] )
{
[self closeSheet:self];
return YES;
} else {
return NO;
}
}
return NO;
}
/*
* A notification posted when the selection changes within the text view;
* used to control the run-currentrun-selection button state and action.
*/
- (void)textViewDidChangeSelection:(NSNotification *)aNotification
{
// Ensure that the notification is from the custom query text view
if ( [aNotification object] != textView ) return;
// To be able to disable runSelectionMenuItem
[[runSelectionMenuItem menu] setAutoenablesItems:NO];
// If no text is selected, disable the button and action menu.
if ( [textView selectedRange].location == NSNotFound ) {
[runSelectionButton setEnabled:NO];
[runSelectionMenuItem setEnabled:NO];
return;
}
// If the current selection is a single caret position, update the button based on
// whether the caret is inside a valid query.
if ([textView selectedRange].length == 0) {
int selectionPosition = [textView selectedRange].location;
int movedRangeStart, movedRangeLength;
BOOL updateQueryButtons = FALSE;
NSRange oldSelection;
// Retrieve the old selection position
[[[aNotification userInfo] objectForKey:@"NSOldSelectedCharacterRange"] getValue:&oldSelection];
// Only process the query text if the selection previously had length, or moved more than 100 characters,
// or the intervening space contained a semicolon, or typing has been performed with no current query.
// This adds more checks to every keypress, but ensures the majority of the actions don't incur a
// parsing overhead - which is cheap on small text strings but heavy of large queries.
movedRangeStart = (selectionPosition < oldSelection.location)?selectionPosition:oldSelection.location;
movedRangeLength = abs(selectionPosition - oldSelection.location);
if (oldSelection.length > 0) updateQueryButtons = TRUE;
if (!updateQueryButtons && movedRangeLength > 100) updateQueryButtons = TRUE;
if (!updateQueryButtons && oldSelection.location > [[textView string] length]) updateQueryButtons = TRUE;
if (!updateQueryButtons && [[textView string] rangeOfString:@";" options:0 range:NSMakeRange(movedRangeStart, movedRangeLength)].location != NSNotFound) updateQueryButtons = TRUE;
if (!updateQueryButtons && ![runSelectionButton isEnabled] && selectionPosition > oldSelection.location
&& [[[[textView string] substringWithRange:NSMakeRange(movedRangeStart, movedRangeLength)] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] length]) updateQueryButtons = TRUE;
if (!updateQueryButtons &&
(
[[runSelectionButton title] isEqualToString:NSLocalizedString(@"Run Current", @"Title of button to run current query in custom query view")]
||
[[runSelectionButton title] isEqualToString:NSLocalizedString(@"Run Previous", @"Title of button to run query just before text caret in custom query view")]
)
) {
int charPosition;
unichar theChar;
for (charPosition = selectionPosition; charPosition > 0; charPosition--) {
theChar = [[textView string] characterAtIndex:charPosition-1];
if (theChar == ';') {
updateQueryButtons = TRUE;
break;
}
if (![[NSCharacterSet whitespaceAndNewlineCharacterSet] characterIsMember:theChar]) break;
}
}
if (!updateQueryButtons && [[runSelectionButton title] isEqualToString:NSLocalizedString(@"Run Previous", @"Title of button to run query just before text caret in custom query view")]) {
int charPosition;
unichar theChar;
for (charPosition = selectionPosition; charPosition > 0; charPosition--) {
theChar = [[textView string] characterAtIndex:charPosition-1];
if (theChar == ';') break;
if (![[NSCharacterSet whitespaceAndNewlineCharacterSet] characterIsMember:theChar]) {
updateQueryButtons = TRUE;
break;
}
}
}
if (updateQueryButtons) {
[runSelectionButton setTitle:NSLocalizedString(@"Run Current", @"Title of button to run current query in custom query view")];
[runSelectionMenuItem setTitle:NSLocalizedString(@"Run Current Query", @"Title of action menu item to run current query in custom query view")];
// If a valid query is present at the cursor position, enable the button
BOOL isLookBehind = YES;
if ([self queryAtPosition:selectionPosition lookBehind:&isLookBehind]) {
if (isLookBehind) {
[runSelectionButton setTitle:NSLocalizedString(@"Run Previous", @"Title of button to run query just before text caret in custom query view")];
[runSelectionMenuItem setTitle:NSLocalizedString(@"Run Previous Query", @"Title of action menu item to run query just before text caret in custom query view")];
}
[runSelectionButton setEnabled:YES];
[runSelectionMenuItem setEnabled:YES];
} else {
[runSelectionButton setEnabled:NO];
[runSelectionMenuItem setEnabled:NO];
}
}
// For selection ranges, enable the button.
} else {
[runSelectionButton setTitle:NSLocalizedString(@"Run Selection", @"Title of button to run selected text in custom query view")];
[runSelectionButton setEnabled:YES];
[runSelectionMenuItem setTitle:NSLocalizedString(@"Run Selected Text", @"Title of action menu item to run selected text in custom query view")];
[runSelectionMenuItem setEnabled:YES];
}
}
/*
* Save the custom query editor font if it is changed.
*/
- (void)textViewDidChangeTypingAttributes:(NSNotification *)aNotification
{
// Only save the font if prefs have been loaded, ensuring the saved font has been applied once.
if (prefs) {
[prefs setObject:[NSArchiver archivedDataWithRootObject:[textView font]] forKey:@"CustomQueryEditorFont"];
}
}
#pragma mark -
#pragma mark TableView notifications
/*
* Updates various interface elements based on the current table view selection.
*/
- (void)tableViewSelectionDidChange:(NSNotification *)notification
{
if ([notification object] == queryFavoritesView) {
// Enable/disable buttons
[removeQueryFavoriteButton setEnabled:([queryFavoritesView numberOfSelectedRows] == 1)];
[copyQueryFavoriteButton setEnabled:([queryFavoritesView numberOfSelectedRows] == 1)];
}
}
#pragma mark -
// Last but not least
- (id)init;
{
self = [super init];
prefs = nil;
usedQuery = [[NSString stringWithString:@""] retain];
return self;
}
- (void)dealloc
{
[queryResult release];
[prefs release];
[queryFavorites release];
[usedQuery release];
[super dealloc];
}
@end