transmission/macosx/MessageWindowController.m

525 lines
20 KiB
Mathematica
Raw Normal View History

2007-09-16 01:02:06 +00:00
/******************************************************************************
2012-01-14 17:12:04 +00:00
* Copyright (c) 2006-2012 Transmission authors and contributors
2007-09-16 01:02:06 +00:00
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*****************************************************************************/
#import "MessageWindowController.h"
#import "Controller.h"
#import "NSApplicationAdditions.h"
#import "NSMutableArrayAdditions.h"
#import "NSStringAdditions.h"
#import <log.h>
2007-09-16 01:02:06 +00:00
#import <transmission.h>
#define LEVEL_ERROR 0
#define LEVEL_INFO 1
#define LEVEL_DEBUG 2
#define UPDATE_SECONDS 0.75
2007-09-16 01:02:06 +00:00
@interface MessageWindowController (Private)
- (void) resizeColumn;
- (BOOL) shouldIncludeMessageForFilter: (NSString *) filterString message: (NSDictionary *) message;
- (void) updateListForFilter;
2007-09-16 01:02:06 +00:00
- (NSString *) stringForMessage: (NSDictionary *) message;
@end
@implementation MessageWindowController
- (id) init
2007-09-16 01:02:06 +00:00
{
2007-12-24 16:18:09 +00:00
return [super initWithWindowNibName: @"MessageWindow"];
2007-09-16 01:02:06 +00:00
}
- (void) awakeFromNib
{
NSWindow * window = [self window];
[window setFrameAutosaveName: @"MessageWindowFrame"];
[window setFrameUsingName: @"MessageWindowFrame"];
[window setRestorationClass: [self class]];
[[NSNotificationCenter defaultCenter] addObserver: self selector: @selector(resizeColumn)
name: NSTableViewColumnDidResizeNotification object: fMessageTable];
[window setContentBorderThickness: NSMinY([[fMessageTable enclosingScrollView] frame]) forEdge: NSMinYEdge];
2008-03-15 20:18:44 +00:00
[[self window] setTitle: NSLocalizedString(@"Message Log", "Message window -> title")];
//set images and text for popup button items
[[fLevelButton itemAtIndex: LEVEL_ERROR] setTitle: NSLocalizedString(@"Error", "Message window -> level string")];
[[fLevelButton itemAtIndex: LEVEL_INFO] setTitle: NSLocalizedString(@"Info", "Message window -> level string")];
[[fLevelButton itemAtIndex: LEVEL_DEBUG] setTitle: NSLocalizedString(@"Debug", "Message window -> level string")];
if (![NSApp isOnYosemiteOrBetter])
{
[[fLevelButton itemAtIndex: LEVEL_ERROR] setImage: [NSImage imageNamed: @"RedDotGlossy"]];
[[fLevelButton itemAtIndex: LEVEL_INFO] setImage: [NSImage imageNamed: @"YellowDotGlossy"]];
[[fLevelButton itemAtIndex: LEVEL_DEBUG] setImage: [NSImage imageNamed: @"PurpleDotGlossy"]];
}
const CGFloat levelButtonOldWidth = NSWidth([fLevelButton frame]);
[fLevelButton sizeToFit];
//set table column text
[[[fMessageTable tableColumnWithIdentifier: @"Date"] headerCell] setTitle: NSLocalizedString(@"Date",
"Message window -> table column")];
[[[fMessageTable tableColumnWithIdentifier: @"Name"] headerCell] setTitle: NSLocalizedString(@"Process",
"Message window -> table column")];
[[[fMessageTable tableColumnWithIdentifier: @"Message"] headerCell] setTitle: NSLocalizedString(@"Message",
"Message window -> table column")];
//set and size buttons
[fSaveButton setTitle: [NSLocalizedString(@"Save", "Message window -> save button") stringByAppendingEllipsis]];
[fSaveButton sizeToFit];
NSRect saveButtonFrame = [fSaveButton frame];
saveButtonFrame.size.width += 10.0;
saveButtonFrame.origin.x += NSWidth([fLevelButton frame]) - levelButtonOldWidth;
[fSaveButton setFrame: saveButtonFrame];
const CGFloat oldClearButtonWidth = [fClearButton frame].size.width;
[fClearButton setTitle: NSLocalizedString(@"Clear", "Message window -> save button")];
[fClearButton sizeToFit];
NSRect clearButtonFrame = [fClearButton frame];
clearButtonFrame.size.width = MAX(clearButtonFrame.size.width + 10.0, saveButtonFrame.size.width);
clearButtonFrame.origin.x -= NSWidth(clearButtonFrame) - oldClearButtonWidth;
[fClearButton setFrame: clearButtonFrame];
[[fFilterField cell] setPlaceholderString: NSLocalizedString(@"Filter", "Message window -> filter field")];
NSRect filterButtonFrame = [fFilterField frame];
filterButtonFrame.origin.x -= NSWidth(clearButtonFrame) - oldClearButtonWidth;
[fFilterField setFrame: filterButtonFrame];
2017-07-29 16:14:22 +00:00
fAttributes = [[[[fMessageTable tableColumnWithIdentifier: @"Message"] dataCell] attributedStringValue]
attributesAtIndex: 0 effectiveRange: NULL];
2007-09-16 01:02:06 +00:00
//select proper level in popup button
switch ([[NSUserDefaults standardUserDefaults] integerForKey: @"MessageLevel"])
2007-10-11 12:06:46 +00:00
{
case TR_LOG_ERROR:
2007-10-11 12:06:46 +00:00
[fLevelButton selectItemAtIndex: LEVEL_ERROR];
break;
case TR_LOG_INFO:
2007-10-11 12:06:46 +00:00
[fLevelButton selectItemAtIndex: LEVEL_INFO];
break;
case TR_LOG_DEBUG:
2007-10-11 12:06:46 +00:00
[fLevelButton selectItemAtIndex: LEVEL_DEBUG];
break;
default: //safety
[[NSUserDefaults standardUserDefaults] setInteger: TR_LOG_ERROR forKey: @"MessageLevel"];
[fLevelButton selectItemAtIndex: LEVEL_ERROR];
2007-10-11 12:06:46 +00:00
}
fMessages = [[NSMutableArray alloc] init];
fDisplayedMessages = [[NSMutableArray alloc] init];
2009-11-28 21:01:27 +00:00
fLock = [[NSLock alloc] init];
}
- (void) dealloc
{
[[NSNotificationCenter defaultCenter] removeObserver: self];
[fTimer invalidate];
}
- (void) windowDidBecomeKey: (NSNotification *) notification
{
if (!fTimer)
2009-12-11 04:01:47 +00:00
{
2017-07-29 16:14:22 +00:00
fTimer = [NSTimer scheduledTimerWithTimeInterval: UPDATE_SECONDS target: self selector: @selector(updateLog:) userInfo: nil repeats: YES];
2009-12-11 04:01:47 +00:00
[self updateLog: nil];
}
2007-09-16 01:02:06 +00:00
}
- (void) windowWillClose: (id)sender
{
[fTimer invalidate];
fTimer = nil;
}
+ (void) restoreWindowWithIdentifier: (NSString *) identifier state: (NSCoder *) state completionHandler: (void (^)(NSWindow *, NSError *)) completionHandler
{
NSAssert1([identifier isEqualToString: @"MessageWindow"], @"Trying to restore unexpected identifier %@", identifier);
NSWindow * window = [[(Controller *)[NSApp delegate] messageWindowController] window];
completionHandler(window, nil);
}
- (void) window: (NSWindow *) window didDecodeRestorableState: (NSCoder *) coder
{
[fTimer invalidate];
2017-07-29 16:14:22 +00:00
fTimer = [NSTimer scheduledTimerWithTimeInterval: UPDATE_SECONDS target: self selector: @selector(updateLog:) userInfo: nil repeats: YES];
[self updateLog: nil];
}
2007-09-16 01:02:06 +00:00
- (void) updateLog: (NSTimer *) timer
{
tr_log_message * messages;
if ((messages = tr_logGetQueue()) == NULL)
2007-09-16 01:02:06 +00:00
return;
2009-11-28 21:01:27 +00:00
[fLock lock];
static NSUInteger currentIndex = 0;
NSScroller * scroller = [[fMessageTable enclosingScrollView] verticalScroller];
const BOOL shouldScroll = currentIndex == 0 || [scroller floatValue] == 1.0 || [scroller isHidden]
|| [scroller knobProportion] == 1.0;
const NSInteger maxLevel = [[NSUserDefaults standardUserDefaults] integerForKey: @"MessageLevel"];
NSString * filterString = [fFilterField stringValue];
BOOL changed = NO;
for (tr_log_message * currentMessage = messages; currentMessage != NULL; currentMessage = currentMessage->next)
{
2017-07-08 08:06:32 +00:00
NSString * name = currentMessage->name != NULL ? @(currentMessage->name)
2008-03-16 15:26:53 +00:00
: [[NSProcessInfo processInfo] processName];
2017-07-08 08:06:32 +00:00
NSString * file = [[@(currentMessage->file) lastPathComponent] stringByAppendingFormat: @":%d",
currentMessage->line];
2017-07-08 15:02:00 +00:00
NSDictionary * message = @{
@"Message": @(currentMessage->message),
@"Date": [NSDate dateWithTimeIntervalSince1970: currentMessage->when],
@"Index": @(currentIndex++), //more accurate when sorting by date
@"Level": @(currentMessage->level),
@"Name": name,
@"File": file};
[fMessages addObject: message];
if (currentMessage->level <= maxLevel && [self shouldIncludeMessageForFilter: filterString message: message])
{
[fDisplayedMessages addObject: message];
changed = YES;
}
}
if ([fMessages count] > TR_LOG_MAX_QUEUE_LENGTH)
{
const NSUInteger oldCount = [fDisplayedMessages count];
NSIndexSet * removeIndexes = [NSIndexSet indexSetWithIndexesInRange: NSMakeRange(0, [fMessages count]-TR_LOG_MAX_QUEUE_LENGTH)];
NSArray * itemsToRemove = [fMessages objectsAtIndexes: removeIndexes];
[fMessages removeObjectsAtIndexes: removeIndexes];
[fDisplayedMessages removeObjectsInArray: itemsToRemove];
changed |= oldCount > [fDisplayedMessages count];
}
if (changed)
{
[fDisplayedMessages sortUsingDescriptors: [fMessageTable sortDescriptors]];
[fMessageTable reloadData];
if (shouldScroll)
[fMessageTable scrollRowToVisible: [fMessageTable numberOfRows]-1];
}
2009-11-28 21:01:27 +00:00
[fLock unlock];
tr_logFreeQueue (messages);
2007-09-16 01:02:06 +00:00
}
- (NSInteger) numberOfRowsInTableView: (NSTableView *) tableView
2007-09-16 01:02:06 +00:00
{
return [fDisplayedMessages count];
2007-09-16 01:02:06 +00:00
}
- (id) tableView: (NSTableView *) tableView objectValueForTableColumn: (NSTableColumn *) column row: (NSInteger) row
2007-09-16 01:02:06 +00:00
{
NSString * ident = [column identifier];
2017-07-08 09:16:01 +00:00
NSDictionary * message = fDisplayedMessages[row];
2007-09-16 01:02:06 +00:00
if ([ident isEqualToString: @"Date"])
2017-07-08 14:38:47 +00:00
return message[@"Date"];
2007-09-16 01:02:06 +00:00
else if ([ident isEqualToString: @"Level"])
{
2017-07-08 14:38:47 +00:00
const NSInteger level = [message[@"Level"] integerValue];
switch (level)
2007-10-01 21:52:31 +00:00
{
case TR_LOG_ERROR:
return [NSImage imageNamed: ([NSApp isOnYosemiteOrBetter] ? @"RedDotFlat" : @"RedDotGlossy")];
case TR_LOG_INFO:
return [NSImage imageNamed: ([NSApp isOnYosemiteOrBetter] ? @"YellowDotFlat" : @"YellowDotGlossy")];
case TR_LOG_DEBUG:
return [NSImage imageNamed: ([NSApp isOnYosemiteOrBetter] ? @"PurpleDotFlat" : @"PurpleDotGlossy")];
2007-10-01 21:52:31 +00:00
default:
NSAssert1(NO, @"Unknown message log level: %ld", level);
2007-10-01 21:52:31 +00:00
return nil;
}
2007-09-16 01:02:06 +00:00
}
else if ([ident isEqualToString: @"Name"])
2017-07-08 14:38:47 +00:00
return message[@"Name"];
2007-09-16 01:02:06 +00:00
else
2017-07-08 14:38:47 +00:00
return message[@"Message"];
2007-09-16 01:02:06 +00:00
}
#warning don't cut off end
- (CGFloat) tableView: (NSTableView *) tableView heightOfRow: (NSInteger) row
{
2017-07-08 14:38:47 +00:00
NSString * message = fDisplayedMessages[row][@"Message"];
NSTableColumn * column = [tableView tableColumnWithIdentifier: @"Message"];
const CGFloat count = floorf([message sizeWithAttributes: fAttributes].width / [column width]);
2012-09-06 03:25:52 +00:00
return [tableView rowHeight] * (count + 1.0);
}
2007-09-16 01:02:06 +00:00
- (void) tableView: (NSTableView *) tableView sortDescriptorsDidChange: (NSArray *) oldDescriptors
{
[fDisplayedMessages sortUsingDescriptors: [fMessageTable sortDescriptors]];
2007-09-16 01:02:06 +00:00
[fMessageTable reloadData];
}
- (NSString *) tableView: (NSTableView *) tableView toolTipForCell: (NSCell *) cell rect: (NSRectPointer) rect
tableColumn: (NSTableColumn *) column row: (NSInteger) row mouseLocation: (NSPoint) mouseLocation
{
2017-07-08 09:16:01 +00:00
NSDictionary * message = fDisplayedMessages[row];
2017-07-08 14:38:47 +00:00
return message[@"File"];
}
2007-09-16 01:02:06 +00:00
- (void) copy: (id) sender
{
NSIndexSet * indexes = [fMessageTable selectedRowIndexes];
NSMutableArray * messageStrings = [NSMutableArray arrayWithCapacity: [indexes count]];
for (NSDictionary * message in [fDisplayedMessages objectsAtIndexes: indexes])
2007-10-12 11:33:26 +00:00
[messageStrings addObject: [self stringForMessage: message]];
NSString * messageString = [messageStrings componentsJoinedByString: @"\n"];
NSPasteboard * pb = [NSPasteboard generalPasteboard];
[pb clearContents];
2017-07-08 08:23:05 +00:00
[pb writeObjects: @[messageString]];
2007-09-16 01:02:06 +00:00
}
- (BOOL) validateMenuItem: (NSMenuItem *) menuItem
{
SEL action = [menuItem action];
2007-09-16 01:02:06 +00:00
if (action == @selector(copy:))
return [fMessageTable numberOfSelectedRows] > 0;
2007-09-16 01:02:06 +00:00
return YES;
}
- (void) changeLevel: (id) sender
{
NSInteger level;
2007-10-01 21:52:31 +00:00
switch ([fLevelButton indexOfSelectedItem])
{
case LEVEL_ERROR:
level = TR_LOG_ERROR;
2007-10-01 21:52:31 +00:00
break;
case LEVEL_INFO:
level = TR_LOG_INFO;
2007-10-01 21:52:31 +00:00
break;
case LEVEL_DEBUG:
level = TR_LOG_DEBUG;
2007-10-01 21:52:31 +00:00
break;
default:
NSAssert1(NO, @"Unknown message log level: %ld", [fLevelButton indexOfSelectedItem]);
level = TR_LOG_INFO;
2007-10-01 21:52:31 +00:00
}
if ([[NSUserDefaults standardUserDefaults] integerForKey: @"MessageLevel"] == level)
return;
2007-09-16 01:02:06 +00:00
[[NSUserDefaults standardUserDefaults] setInteger: level forKey: @"MessageLevel"];
[fLock lock];
[self updateListForFilter];
[fLock unlock];
}
- (void) changeFilter: (id) sender
{
[fLock lock];
[self updateListForFilter];
2009-11-28 21:01:27 +00:00
[fLock unlock];
2007-09-16 01:02:06 +00:00
}
- (void) clearLog: (id) sender
{
[fLock lock];
2007-09-16 01:02:06 +00:00
[fMessages removeAllObjects];
[fMessageTable beginUpdates];
[fMessageTable removeRowsAtIndexes: [NSIndexSet indexSetWithIndexesInRange: NSMakeRange(0, [fDisplayedMessages count])] withAnimation: NSTableViewAnimationSlideLeft];
[fDisplayedMessages removeAllObjects];
[fMessageTable endUpdates];
[fLock unlock];
2007-09-16 01:02:06 +00:00
}
- (void) writeToFile: (id) sender
{
NSSavePanel * panel = [NSSavePanel savePanel];
2017-07-08 08:23:05 +00:00
[panel setAllowedFileTypes: @[@"txt"]];
2007-09-16 01:02:06 +00:00
[panel setCanSelectHiddenExtension: YES];
[panel setNameFieldStringValue: NSLocalizedString(@"untitled", "Save log panel -> default file name")];
[panel beginSheetModalForWindow: [self window] completionHandler: ^(NSInteger result) {
if (result == NSFileHandlingPanelOKButton)
2007-09-16 01:02:06 +00:00
{
//make the array sorted by date
NSSortDescriptor * descriptor = [NSSortDescriptor sortDescriptorWithKey: @"Index" ascending: YES];
NSArray * descriptors = [[NSArray alloc] initWithObjects: descriptor, nil];
NSArray * sortedMessages = [fDisplayedMessages sortedArrayUsingDescriptors: descriptors];
//create the text to output
NSMutableArray * messageStrings = [NSMutableArray arrayWithCapacity: [sortedMessages count]];
for (NSDictionary * message in sortedMessages)
[messageStrings addObject: [self stringForMessage: message]];
NSString * fileString = [messageStrings componentsJoinedByString: @"\n"];
if (![fileString writeToFile: [[panel URL] path] atomically: YES encoding: NSUTF8StringEncoding error: nil])
{
NSAlert * alert = [[NSAlert alloc] init];
[alert addButtonWithTitle: NSLocalizedString(@"OK", "Save log alert panel -> button")];
[alert setMessageText: NSLocalizedString(@"Log Could Not Be Saved", "Save log alert panel -> title")];
[alert setInformativeText: [NSString stringWithFormat:
NSLocalizedString(@"There was a problem creating the file \"%@\".",
"Save log alert panel -> message"), [[[panel URL] path] lastPathComponent]]];
[alert setAlertStyle: NSWarningAlertStyle];
[alert runModal];
}
2007-09-16 01:02:06 +00:00
}
}];
2007-09-16 01:02:06 +00:00
}
@end
@implementation MessageWindowController (Private)
- (void) resizeColumn
{
[fMessageTable noteHeightOfRowsWithIndexesChanged: [NSIndexSet indexSetWithIndexesInRange:
NSMakeRange(0, [fMessageTable numberOfRows])]];
}
- (BOOL) shouldIncludeMessageForFilter: (NSString *) filterString message: (NSDictionary *) message
{
if ([filterString isEqualToString: @""])
return YES;
const NSStringCompareOptions searchOptions = NSCaseInsensitiveSearch | NSDiacriticInsensitiveSearch;
2017-07-08 14:38:47 +00:00
return [message[@"Name"] rangeOfString: filterString options: searchOptions].location != NSNotFound
|| [message[@"Message"] rangeOfString: filterString options: searchOptions].location != NSNotFound;
}
- (void) updateListForFilter
{
const NSInteger level = [[NSUserDefaults standardUserDefaults] integerForKey: @"MessageLevel"];
NSString * filterString = [fFilterField stringValue];
NSIndexSet * indexes = [fMessages indexesOfObjectsWithOptions: NSEnumerationConcurrent passingTest: ^BOOL(id message, NSUInteger idx, BOOL * stop) {
2017-07-08 14:38:47 +00:00
return [((NSDictionary *)message)[@"Level"] integerValue] <= level && [self shouldIncludeMessageForFilter: filterString message: message];
}];
NSArray * tempMessages = [[fMessages objectsAtIndexes: indexes] sortedArrayUsingDescriptors: [fMessageTable sortDescriptors]];
[fMessageTable beginUpdates];
//figure out which rows were added/moved
NSUInteger currentIndex = 0, totalCount = 0;
NSMutableArray * itemsToAdd = [NSMutableArray array];
NSMutableIndexSet * itemsToAddIndexes = [NSMutableIndexSet indexSet];
for (NSDictionary * message in tempMessages)
{
const NSUInteger previousIndex = [fDisplayedMessages indexOfObject: message inRange: NSMakeRange(currentIndex, [fDisplayedMessages count]-currentIndex)];
if (previousIndex == NSNotFound)
{
[itemsToAdd addObject: message];
[itemsToAddIndexes addIndex: totalCount];
}
else
{
if (previousIndex != currentIndex)
{
[fDisplayedMessages moveObjectAtIndex: previousIndex toIndex: currentIndex];
[fMessageTable moveRowAtIndex: previousIndex toIndex: currentIndex];
}
++currentIndex;
}
++totalCount;
}
//remove trailing items - those are the unused
if (currentIndex < [fDisplayedMessages count])
{
const NSRange removeRange = NSMakeRange(currentIndex, [fDisplayedMessages count]-currentIndex);
[fDisplayedMessages removeObjectsInRange: removeRange];
[fMessageTable removeRowsAtIndexes: [NSIndexSet indexSetWithIndexesInRange: removeRange] withAnimation: NSTableViewAnimationSlideDown];
}
//add new items
[fDisplayedMessages insertObjects: itemsToAdd atIndexes: itemsToAddIndexes];
[fMessageTable insertRowsAtIndexes: itemsToAddIndexes withAnimation: NSTableViewAnimationSlideUp];
[fMessageTable endUpdates];
2011-07-21 22:12:34 +00:00
NSAssert2([fDisplayedMessages isEqualToArray: tempMessages], @"Inconsistency between message arrays! %@ %@", fDisplayedMessages, tempMessages);
}
2007-09-16 01:02:06 +00:00
- (NSString *) stringForMessage: (NSDictionary *) message
{
NSString * levelString;
2017-07-08 14:38:47 +00:00
const NSInteger level = [message[@"Level"] integerValue];
switch (level)
2007-10-01 21:52:31 +00:00
{
case TR_LOG_ERROR:
levelString = NSLocalizedString(@"Error", "Message window -> level");
2007-10-01 21:52:31 +00:00
break;
case TR_LOG_INFO:
levelString = NSLocalizedString(@"Info", "Message window -> level");
2007-10-01 21:52:31 +00:00
break;
case TR_LOG_DEBUG:
levelString = NSLocalizedString(@"Debug", "Message window -> level");
2007-10-01 21:52:31 +00:00
break;
default:
NSAssert1(NO, @"Unknown message log level: %ld", level);
levelString = @"?";
2007-10-01 21:52:31 +00:00
}
2017-07-08 14:38:47 +00:00
return [NSString stringWithFormat: @"%@ %@ [%@] %@: %@", message[@"Date"],
message[@"File"], levelString,
message[@"Name"], message[@"Message"], nil];
2007-09-16 01:02:06 +00:00
}
@end