QSSpotlightObjectSource.m

//
//  QSSpotlightObjectSource.m
//  QSSpotlightPlugIn
//
//  Created by Nicholas Jitkoff on 3/26/05.
//  Rewritten by Rob McBroom 3/22/2012
//

#import "QSSpotlightObjectSource.h"

@implementation QSSpotlightObjectSource
- (id)init
{
	self = [super init];
	if (self != nil) {
		[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(arrayLoaded:) name:NSMetadataQueryDidFinishGatheringNotification object:nil];
	}
	return self;
}

- (void)dealloc
{
	[[NSNotificationCenter defaultCenter] removeObserver:self name:NSMetadataQueryDidFinishGatheringNotification object:nil];
}

- (void)arrayLoaded:(NSNotification *)notif
{
	// Spotlight query results are ready
	NSMetadataQuery *query = [notif object];
	[query stopQuery];
	// continue processing in objectsForEntry
	CFRunLoopStop(CFRunLoopGetCurrent());
}

- (NSImage *)iconForEntry:(NSDictionary *)theEntry
{
	return [QSResourceManager imageNamed:@"Find"];
}

- (NSArray *)objectsForEntry:(QSCatalogEntry *)theEntry
{
	// check that settings are in the right place
	if ([theEntry objectForKey:@"query"]) {
		[self relocateSettings:theEntry];
	}
	// initiate the search
	NSMutableDictionary *settings = theEntry.sourceSettings;
	NSString *searchString = [settings objectForKey:@"query"];
	NSString *path = [settings objectForKey:@"path"];
	BOOL localDiskOnly = [[settings objectForKey:@"ignoreRemovable"] boolValue];
	NSMutableSet *skipPrefixes = [NSMutableSet setWithObjects:@"tmp", @"private", nil];
	if (localDiskOnly) {
		// don't include results from FireWire, USB, etc.
		[skipPrefixes addObject:@"Volumes"];
	}
	NSMetadataQuery *query = [[NSMetadataQuery alloc] init];
	NSMutableArray *objects = [NSMutableArray array];
	@try {
		if (path) {
			[query resultsForSearchString:searchString inFolders:[NSSet setWithObject:path]];
		} else {
			[query resultsForSearchString:searchString];
		}
		// process search results
		NSString *resultPath = nil;
		// fast enumeration is not recommended for NSMetadataQuery
		for (NSUInteger i = 0; i < [query resultCount]; i++) {
			// get the path and create a QSObject with it
			resultPath = [[query resultAtIndex:i] valueForAttribute:@"kMDItemPath"];
			// omit ignored paths
			NSString *root = [[resultPath pathComponents] objectAtIndex:1];
			if ([skipPrefixes containsObject:root]) {
				continue;
			}
			[objects addObject:[QSObject fileObjectWithPath:resultPath]];
		}
	}
	@catch (NSException *exception) {
		if ([[exception name] isEqualToString:@"NSInvalidArgumentException"]) {
			NSLog(@"invalid syntax for Spotlight catalog entry: %@", searchString);
		} else {
			NSLog(@"Spotlight catalog entry failed: %@", exception);
		}
	}
	query = nil;
	return objects;
}

- (BOOL)isVisibleSource
{
	return YES;
}

- (BOOL)indexIsValidFromDate:(NSDate *)indexDate forEntry:(NSDictionary *)theEntry
{
	// no good way to tell if the results will be different, so always rescan
	return NO;
}

- (NSView *)settingsView
{
	if (![super settingsView]) {
		[[NSBundle bundleForClass:[self class]] loadNibNamed:NSStringFromClass([self class]) owner:self topLevelObjects:NULL];
	}
	return [super settingsView];
}

- (IBAction)selectSearchPath:(NSButton *)sender
{
	NSMutableDictionary *settings = self.selectedEntry.sourceSettings;
	NSOpenPanel *openPanel = [NSOpenPanel openPanel];
	NSString *oldPath = [[settings objectForKey:kItemPath] stringByStandardizingPath];
	if (!oldPath) {
		oldPath = @"/";
	}
	[openPanel setCanChooseDirectories:YES];
	[openPanel setCanChooseFiles:NO];
	[openPanel setDirectoryURL:[NSURL fileURLWithPath:oldPath]];
	if (![openPanel runModal]) return;
	NSString *newPath = [[openPanel URL] path];
	[searchPath setStringValue:[newPath stringByAbbreviatingWithTildeInPath]];
	// update catalog entry
	[settings setObject:newPath forKey:kItemPath];
	//[settings setObject:[settings objectForKey:@"query"] forKey:kItemName];
	[settings setObject:[NSNumber numberWithDouble:[NSDate timeIntervalSinceReferenceDate]] forKey:kItemModificationDate];
	[[NSNotificationCenter defaultCenter] postNotificationName:QSCatalogEntryChangedNotification object:[self selectedEntry]];
}

- (NSString *)valueForUndefinedKey:(NSString *)key
{
	// prevent exceptions when entries created with older versions of the plug-in are loaded
	return nil;
}

#pragma mark Catalog API Upgrade

- (void)relocateSettings:(QSCatalogEntry *)theEntry
{
	NSMutableDictionary *settings = theEntry.sourceSettings;
	NSArray *settingToMove = @[
		@"query",
		kItemPath,
		@"ignoreRemovable",
	];
	for (NSString *key in settingToMove) {
		[settings setObject:theEntry.info[key] forKey:key];
	}
	[theEntry.info removeObjectsForKeys:settingToMove];
	[[NSNotificationCenter defaultCenter] postNotificationName:QSCatalogEntryChangedNotification object:theEntry];
}
@end