AlienNoteImporter.m

//
//  AlienNoteImporter.m
//  Notation
//
//  Created by Zachary Schneirov on 11/15/06.
//  Copyright 2006 Zachary Schneirov. All rights reserved.
//

#import "AlienNoteImporter.h"
#import "StickiesDocument.h"
#import "BlorPasswordRetriever.h"
#import "URLGetter.h"
#import "GlobalPrefs.h"
#import "AttributedPlainText.h"
#import "NSData_transformations.h"
#import "NSString_NV.h"
#import "NotationPrefs.h"
#import "NotationController.h"
#import "NoteObject.h"

NSString *PasswordWasRetrievedFromKeychainKey = @"PasswordRetrievedFromKeychain";
NSString *RetrievedPasswordKey = @"RetrievedPassword";

@interface AlienNoteImporter (Private)
- (NSArray*)_importStickies:(NSString*)filename;
- (NSArray*)_importBlorNotes:(NSString*)filename;
- (NSArray*)_importTSVFile:(NSString*)filename;
@end

@implementation AlienNoteImporter

- (id)init {
	if ([super init]) {
		
		documentSettings = [[NSMutableDictionary alloc] init];
	}
	return self;
}

+ (void)importBlorOrHelpFilesIfNecessaryIntoNotation:(NotationController*)notation {
	GlobalPrefs *prefsController = [GlobalPrefs defaultPrefs];
	NotationPrefs *prefs = [prefsController notationPrefs];
	if (![prefsController triedToImportBlor] && [prefs firstTimeUsed]) {
		AlienNoteImporter *importer = [AlienNoteImporter importerWithPath:[AlienNoteImporter blorPath]];
		NSArray *noteArray = [importer importedNotes];
		if ([noteArray count] > 0) {
			NSLog(@"importing BLOR");
			NSData *passData = [[[importer documentSettings] objectForKey:RetrievedPasswordKey] dataUsingEncoding:NSUTF8StringEncoding];
			BOOL shouldStoreInKeychain = [[[importer documentSettings] objectForKey:PasswordWasRetrievedFromKeychainKey] boolValue];
			[prefs setPassphraseData:passData inKeychain:shouldStoreInKeychain];
			[prefs setDoesEncryption:YES];
			
			[notation addNotes:noteArray];
		} else {
			//add localized RTF help notes (how do we handle initializing a new NV copy when the owner just wants to re-sync from web? they will get new help notes each time?)
			NSArray *paths = [[NSBundle mainBundle] pathsForResourcesOfType:@"nvhelp" inDirectory:nil];
			NSArray *helpNotes = [[[[AlienNoteImporter alloc] initWithStoragePaths:paths] autorelease] importedNotes];
			if ([helpNotes count] > 0) {
				[notation addNotes:helpNotes];
				[[notation delegate] notation:notation revealNote:[helpNotes lastObject]];
			}
		}
		[prefsController setBlorImportAttempted:YES];
	}
}

+ (AlienNoteImporter *)importerWithPath:(NSString*)path {
	AlienNoteImporter *importer = [[AlienNoteImporter alloc] initWithStoragePath:path];
	return [importer autorelease];
}

+ (NSString*)blorPath {
	NSDictionary *oldDict = [[NSUserDefaults standardUserDefaults] persistentDomainForName:@"com.scrod.notationalvelocity"];
	NSString *blorPath = [oldDict objectForKey:@"DatabaseLocation"];
	if (!blorPath) {
		NSLog(@"Couldn't read old defaults--reverting to default location in prefs directory");
		blorPath = [NSString stringWithFormat:@"%@/Library/Preferences/%@", NSHomeDirectory(), @"NotationalDatabase.blor"];
	}
	return blorPath;
}

- (id)initWithStoragePaths:(NSArray*)filenames {
	if ([self init]) {
		if ((source = [filenames retain])) {
		
			importerSelector = @selector(notesWithPaths:);
		} else {
			return nil;
		}
	}
	
	return self;
}

- (id)initWithStoragePath:(NSString*)filename {
	if ([self init]) {
		if ((source = [filename retain])) {
			
			//auto-detect based on bundle/extension/metadata
			
			NSDictionary *pathAttributes = [[NSFileManager defaultManager] fileAttributesAtPath:filename traverseLink:YES];
			if ([[filename pathExtension] caseInsensitiveCompare:@"rtfd"] != NSOrderedSame &&
				[[pathAttributes objectForKey:NSFileType] isEqualToString:NSFileTypeDirectory]) {
				
				importerSelector = @selector(notesInDirectory:);
			} else {
				importerSelector = @selector(notesInFile:);
			}
		} else {
			return nil;
		}
	}
	
	return self;
}

- (void)dealloc {
	[documentSettings release];
	[source release];
	
	[super dealloc];
}

+ (NSBundle *)PDFKitBundle {
	static NSBundle *PDFKitBundle = nil;
	if (PDFKitBundle == nil) {
		NSString *PDFKitPath = @"/System/Library/Frameworks/Quartz.framework/Frameworks/PDFKit.framework";
		if (![[NSFileManager defaultManager] fileExistsAtPath:PDFKitPath]) {
			NSLog(@"Couldn't find PDFKit.framework");
			return nil;
		}
		PDFKitBundle = [NSBundle bundleWithPath:PDFKitPath];
		if (![PDFKitBundle load]) {
			NSLog(@"Couldn't load PDFKit.framework");
		}
	}
	return PDFKitBundle;
}

+ (Class)PDFDocClass {
	static Class PDFDocClass = nil;
	if (PDFDocClass == nil) {
		PDFDocClass = [[self PDFKitBundle] classNamed:@"PDFDocument"];
		if (PDFDocClass == nil) {
			NSLog(@"Couldn't find PDFDocument class in PDFKit.framework");
		}
	}
	return PDFDocClass;
}

- (NSDictionary*)documentSettings {
	return documentSettings;
}

- (void)openPanelDidEnd:(NSOpenPanel *)panel returnCode:(int)returnCode contextInfo:(void  *)contextInfo {
	id delegate = (id)contextInfo;
	
	if (delegate && [delegate respondsToSelector:@selector(noteImporter:importedNotes:)]) {
		
		if (returnCode == NSOKButton) {
			NSArray *notes = [self notesWithPaths:[panel filenames]];
			if (notes && [notes count])
				[delegate noteImporter:self importedNotes:notes];
			else
				NSRunAlertPanel(NSLocalizedString(@"None of the selected files could be imported.",nil), 
								NSLocalizedString(@"Please choose other files.",nil), NSLocalizedString(@"OK",nil),nil,nil);
		}
	} else {
		NSLog(@"Where's my note importing delegate?");
		NSBeep();
	}
	
	[self release];
}

- (void)importNotesFromDialogAroundWindow:(NSWindow*)mainWindow receptionDelegate:(id)receiver {
	NSOpenPanel *openPanel = [NSOpenPanel openPanel];
	[openPanel setCanChooseFiles:YES];
	[openPanel setAllowsMultipleSelection:YES];
	[openPanel setCanChooseDirectories:YES];
	[openPanel setPrompt:NSLocalizedString(@"Import",@"title of button in import dialog")];
	[openPanel setTitle:NSLocalizedString(@"Import Notes",@"title of import dialog")];
	[openPanel setMessage:NSLocalizedString(@"Select files and folders from which to import notes.",@"import dialog message")];
	
	[self retain];
	
	[openPanel beginSheetForDirectory:nil file:nil types:nil modalForWindow:mainWindow modalDelegate:self 
					   didEndSelector:@selector(openPanelDidEnd:returnCode:contextInfo:) contextInfo:receiver];
}

- (void)URLGetter:(URLGetter*)getter returnedDownloadedFile:(NSString*)filename {
	
	BOOL foundNotes = NO;
	if ([receptionDelegate respondsToSelector:@selector(noteImporter:importedNotes:)]) {

		if (filename) {
			NSArray *notes = [self notesInFile:filename];
			if ([notes count]) {
				
				NSMutableAttributedString *content = [[[[notes lastObject] contentString] mutableCopy] autorelease];
				if ([[[content string] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] length]) {
					//only add string if it has at least one non-whitespace character
					[content prefixWithSourceString:[[getter url] absoluteString]];
					[content santizeForeignStylesForImporting];
					
					[[notes lastObject] setContentString:content];
					if ([getter userData]) [[notes lastObject] setTitleString:[getter userData]];
					
					[receptionDelegate noteImporter:self importedNotes:notes];
					
					foundNotes = YES;
				}
			}
		}
		if (!foundNotes) {	
			//no notes recovered from downloaded file--just add the URL as a string?
			NSString *urlString = [[getter url] absoluteString];			
			if (urlString) {
				NSMutableAttributedString *newString = [[[NSMutableAttributedString alloc] initWithString:urlString] autorelease];
				[newString santizeForeignStylesForImporting];
				
				NoteObject *noteObject = [[NoteObject alloc] initWithNoteBody:newString title:[getter userData] ? [getter userData] : urlString
															   uniqueFilename:nil format:SingleDatabaseFormat];
				
				[receptionDelegate noteImporter:self importedNotes:[NSArray arrayWithObject:noteObject]];
				[noteObject autorelease];
			}
		}			
		
	} else {
		NSLog(@"Where's my note importing delegate?");
		NSBeep();
	}
	
	[getter release];
	
	[self release];
}

- (void)importURLInBackground:(NSURL*)aURL linkTitle:(NSString*)linkTitle receptionDelegate:(id)receiver {
	
	receptionDelegate = receiver;
		
	[self retain];
	
	(void)[[URLGetter alloc] initWithURL:aURL delegate:self userData:linkTitle];
}

- (NSArray*)importedNotes {
	if (!importerSelector) return nil;
	return [self performSelector:importerSelector withObject:source];
}

- (NSArray*)notesWithPaths:(NSArray*)paths {
	if ([paths isKindOfClass:[NSArray class]]) {
		
		NSMutableArray *array = [NSMutableArray array];
		NSFileManager *fileMan = [NSFileManager defaultManager];
		unsigned int i;
		for (i=0; i<[paths count]; i++) {
			NSString *path = [paths objectAtIndex:i];
			NSArray *notes = nil;
			
			NSDictionary *pathAttributes = [fileMan fileAttributesAtPath:path traverseLink:YES];
			if ([[path pathExtension] caseInsensitiveCompare:@"rtfd"] != NSOrderedSame &&
				[[pathAttributes objectForKey:NSFileType] isEqualToString:NSFileTypeDirectory]) {
				notes = [self notesInDirectory:path];
			} else {
				notes = [self notesInFile:path];
			}
			
			if (notes)
				[array addObjectsFromArray:notes];
		}
		
		return array;
	} else {
		NSLog(@"notesWithPaths: has the wrong kind of object!");
	}
	
	return nil;
}

//auto-detect based on file type/extension/header
//if unable to find, revert to spotlight importer
- (NoteObject*)noteWithFile:(NSString*)filename {
	//RTF, Text, Word, HTML, and anything else we can do without too much effort
	NSString *extension = [[filename pathExtension] lowercaseString];
	NSDictionary *attributes = [[NSFileManager defaultManager] fileAttributesAtPath:filename traverseLink:YES];
	unsigned long fileType = [[attributes objectForKey:NSFileHFSTypeCode] unsignedLongValue];
	
	NSMutableAttributedString *attributedStringFromData = nil;
	
	if (fileType == HTML_TYPE_ID || [extension isEqualToString:@"htm"] || [extension isEqualToString:@"html"] || [extension isEqualToString:@"shtml"]) {
		//should convert to text with markdown here
		attributedStringFromData = [[NSMutableAttributedString alloc] initWithHTML:[NSData dataWithContentsOfFile:filename] documentAttributes:NULL];
		
	} else if (fileType == RTF_TYPE_ID || [extension isEqualToString:@"rtf"] || [extension isEqualToString:@"nvhelp"] || [extension isEqualToString:@"rtx"]) {
		attributedStringFromData = [[NSMutableAttributedString alloc] initWithRTF:[NSData dataWithContentsOfFile:filename] documentAttributes:NULL];
		
	} else if (fileType == RTFD_TYPE_ID || [extension isEqualToString:@"rtfd"]) {
		NSFileWrapper *wrapper = [[[NSFileWrapper alloc] initWithPath:filename] autorelease];
		if ([[attributes objectForKey:NSFileType] isEqualToString:NSFileTypeDirectory])
			attributedStringFromData = [[NSMutableAttributedString alloc] initWithRTFDFileWrapper:wrapper documentAttributes:NULL];
		else
			attributedStringFromData = [[NSMutableAttributedString alloc] initWithRTFD:[NSData dataWithContentsOfFile:filename] documentAttributes:NULL];
		
	} else if (fileType == WORD_DOC_TYPE_ID || [extension isEqualToString:@"doc"]) {
		attributedStringFromData = [[NSMutableAttributedString alloc] initWithDocFormat:[NSData dataWithContentsOfFile:filename] documentAttributes:NULL];
		
	} else if ([extension isEqualToString:@"docx"] || [extension isEqualToString:@"webarchive"]) {
		if (RunningTigerAppKitOrHigher) {
			//make it guess for us, but if it's a webarchive we'll get the URL
			NSData *data = [NSData dataWithContentsOfFile:filename];
			NSString *path = [data pathURLFromWebArchive];
			attributedStringFromData = [[NSMutableAttributedString alloc] initWithData:data options:nil documentAttributes:NULL error:NULL];
			
			if ([path length] > 0 && [attributedStringFromData length] > 0)
				[attributedStringFromData prefixWithSourceString:path];
		}
	} else if (fileType == PDF_TYPE_ID || [extension isEqualToString:@"pdf"]) {
		//try PDFKit if on 10.4
		if (RunningTigerAppKitOrHigher) {
			Class PdfDocClass = [[self class] PDFDocClass];
			if (PdfDocClass != Nil) {
				id doc = [[PdfDocClass alloc] initWithData:[NSData dataWithContentsOfFile:filename]];
				if (doc) {
					id sel = [doc performSelector:@selector(selectionForEntireDocument)];
					if (sel) {
						attributedStringFromData = [[NSMutableAttributedString alloc] initWithAttributedString:[sel attributedString]];
						//maybe we could check pages and boundsForPage: to try to determine where a line was soft-wrapped in the document?
					} else {
						NSLog(@"Couldn't get entire doc selection for PDF");
					}
					[doc release];
				} else {
					NSLog(@"Couldn't parse data into PDF");
				}
			} else {
				NSLog(@"No PDFDocument!");
			}
		}
	} else if (fileType == TEXT_TYPE_ID || [extension isEqualToString:@"txt"] || [extension isEqualToString:@"text"]) {
		
		NSMutableString *stringFromData = nil;
		NSStringEncoding defaultEncoding = [NSString defaultCStringEncoding];
		if ((stringFromData = [NSMutableString newShortLivedStringFromData:[NSMutableData dataWithContentsOfFile:filename] ofGuessedEncoding:&defaultEncoding])) {
			attributedStringFromData = [[NSMutableAttributedString alloc] initWithString:stringFromData 
																			  attributes:[[GlobalPrefs defaultPrefs] noteBodyAttributes]];
			[stringFromData release];
		}
		
	}
	// else {
		//try spotlight importer if on 10.4
	//}
		

	if (attributedStringFromData) {
		[attributedStringFromData trimLeadingWhitespace];
		[attributedStringFromData removeAttachments];
		[attributedStringFromData santizeForeignStylesForImporting];
		[attributedStringFromData autorelease];
		
		//we do not use filename as uniqueFilename, as we are only importing--not taking ownership
		NoteObject *noteObject = [[NoteObject alloc] initWithNoteBody:attributedStringFromData title:[[filename lastPathComponent] stringByDeletingPathExtension]
														uniqueFilename:nil format:SingleDatabaseFormat];				
		if (noteObject) {
			//[noteObject setDateAdded:CFDateGetAbsoluteTime((CFDateRef)[attributes objectForKey:NSFileCreationDate])];
			[noteObject setDateModified:CFDateGetAbsoluteTime((CFDateRef)[attributes objectForKey:NSFileModificationDate])];
			
			return [noteObject autorelease];
		} else {
			NSLog(@"couldn't generate note object from imported attributed string??");
		}
		
	}
	return nil;
}

- (NSArray*)notesInDirectory:(NSString*)filename {
	
	//recurse through all subdirectories calling notesInFile where appropriate and collecting arrays into one
	//NSDirectoryEnumerator *enumerator  = [[NSFileManager defaultManager] enumeratorAtPath:filename];
	NSArray *filenames = [[NSFileManager defaultManager] directoryContentsAtPath:filename];
	NSEnumerator *enumerator = [filenames objectEnumerator];
	
	NSMutableArray *array = [NSMutableArray array];
	
	NSString *curObject = nil;
	NSFileManager *fileMan = [NSFileManager defaultManager];
	while ((curObject = [enumerator nextObject])) {
		NSAutoreleasePool *innerPool = [[NSAutoreleasePool alloc] init];
		
		NSString *itemPath = [filename stringByAppendingPathComponent:curObject];
			
		if ([[[fileMan fileAttributesAtPath:itemPath traverseLink:YES] objectForKey:NSFileType] isEqualToString:NSFileTypeRegular]) {
			NSArray *notes = [self notesInFile:itemPath];
			if (notes)
				[array addObjectsFromArray:notes];
		}
		[innerPool release];
	}
	
	return array;
}

- (NSArray*)notesInFile:(NSString*)filename {
	NSString *extension = [[filename pathExtension] lowercaseString];
	
	if ([extension isEqualToString:@"blor"]) {
		return [self _importBlorNotes:filename];
	} else if ([[filename lastPathComponent] isEqualToString:@"StickiesDatabase"]) {
		return [self _importStickies:filename];
	} else if ([extension isEqualToString:@"tsv"]) {
        return [self _importTSVFile:filename];
	} else {
		NoteObject *note = [self noteWithFile:filename];
		if (note)
			return [NSArray arrayWithObject:note];
	}
	return nil;
}

@end

@implementation AlienNoteImporter (Private)

- (NSArray*)_importStickies:(NSString*)filename {
	NSMutableArray *stickyNotes = nil;
	NS_DURING
		NSData *stickyData = [NSData dataWithContentsOfFile:filename];
		NSUnarchiver *unarchiver = [[NSUnarchiver alloc] initForReadingWithData:stickyData];
		[unarchiver decodeClassName:@"Document" asClassName:@"StickiesDocument"];
		stickyNotes = [[unarchiver decodeObject] retain];
		[unarchiver release];
	NS_HANDLER
		stickyNotes = nil;
		NSLog(@"Error parsing stickies database: %@", [localException reason]);
	NS_ENDHANDLER
	
	if (stickyNotes && [stickyNotes isKindOfClass:[NSMutableArray class]]) {
		NSMutableArray *notes = [NSMutableArray arrayWithCapacity:[stickyNotes count]];
		
		unsigned int i;
		for (i=0; i<[stickyNotes count]; i++) {
			StickiesDocument *doc = [stickyNotes objectAtIndex:i];
			if ([doc isKindOfClass:[StickiesDocument class]]) {
				NSMutableAttributedString *attributedString = [[[NSMutableAttributedString alloc] initWithRTFD:[doc RTFDData] documentAttributes:NULL] autorelease];
				[attributedString removeAttachments];
				[attributedString santizeForeignStylesForImporting];
				
				NoteObject *noteObject = [[[NoteObject alloc] initWithNoteBody:attributedString title:[[attributedString string] syntheticTitle]
																uniqueFilename:nil format:SingleDatabaseFormat] autorelease];				
				if (noteObject) {
					[noteObject setDateAdded:CFDateGetAbsoluteTime((CFDateRef)[doc creationDate])];
					[noteObject setDateModified:CFDateGetAbsoluteTime((CFDateRef)[doc modificationDate])];

					[notes addObject:noteObject];
				} else {
					NSLog(@"couldn't generate note object from sticky note??");
				}
			} else {
				NSLog(@"Sticky document is wrong: %@", [doc description]);
			}
		}
		
		[stickyNotes release];
		
		return notes;
	} else {
		NSLog(@"Sticky notes array is wrong: %@", [stickyNotes description]);
	}
	
	return nil;
}

- (NSArray*)_importBlorNotes:(NSString*)filename {
	
	BlorPasswordRetriever *retriever = [[[BlorPasswordRetriever alloc] initWithBlor:filename] autorelease];
	NSData *keyData = [retriever validPasswordHashData];
	if (!keyData) {
		NSLog(@"Couldn't get a valid pass-key to decrypt the blor!");
		return nil;
	}
	
	[documentSettings setObject:[NSNumber numberWithBool:[retriever canRetrieveFromKeychain]]
						 forKey:PasswordWasRetrievedFromKeychainKey];
	[documentSettings setObject:[retriever originalPasswordString] forKey:RetrievedPasswordKey];
	
	NSDictionary *dbAttrs = [[NSFileManager defaultManager] fileAttributesAtPath:filename traverseLink:YES];
	NSDate *creationDate = [dbAttrs objectForKey:NSFileCreationDate];
	NSDate *modificationDate = [dbAttrs objectForKey:NSFileModificationDate];
	
	CFAbsoluteTime creationTime = CFAbsoluteTimeGetCurrent();
	CFAbsoluteTime modificationTime = creationTime;
	if (creationDate) creationTime = CFDateGetAbsoluteTime((CFDateRef)creationDate);
	if (modificationDate) modificationTime = CFDateGetAbsoluteTime((CFDateRef)modificationDate);
	
	//iterate over notes with blorenumerator and return array
	BlorNoteEnumerator *enumerator = [[BlorNoteEnumerator alloc] initWithBlor:filename passwordHashData:keyData];
	if (!enumerator) {
		NSLog(@"couldn't initialize blor note enumerator!");
		return nil;
	}
	NSMutableArray *array = [NSMutableArray array];
	NoteObject *note = nil;
	unsigned int count = 0;
	while ((note = [enumerator nextNote])) {
		count ++;
		
		[array addObject:note];
		
		[note setDateAdded:(creationTime += 1.0)];
		[note setDateModified:(modificationTime += 1.0)];
	}
	
	if (count != [enumerator suspectedNoteCount]) {
		NSLog(@"read notes (%d) != stated note count (%d)!", count, [enumerator suspectedNoteCount]);
	}
	
	[enumerator release];
	
	return array;
}

- (NSArray*)_importTSVFile:(NSString*)filename
{
	NSMutableString *contents = nil;
	NSStringEncoding defaultEncoding = [NSString defaultCStringEncoding];
	if (!(contents = [NSMutableString newShortLivedStringFromData:[NSMutableData dataWithContentsOfFile:filename] ofGuessedEncoding:&defaultEncoding])) {
		return nil;
	}
    
    // normalize newlines
    [contents replaceOccurrencesOfString:@"\r\n" withString:@"\n" options:0 range:NSMakeRange(0, [contents length])];
    [contents replaceOccurrencesOfString:@"\r" withString:@"\n" options:0 range:NSMakeRange(0, [contents length])];
    
    NSMutableArray *notes = [NSMutableArray array];
    NSArray *lines = [contents componentsSeparatedByString:@"\n"];
    NSEnumerator *en = [lines objectEnumerator];
    NSString *curLine;
    // Assume first entry in line is note title and any other entries go in the note body
    while ((curLine = [en nextObject])) {
        NSArray *fields = [curLine componentsSeparatedByString:@"\t"];
        NSUInteger count = [fields count];
        if (count > 1) {
            NSMutableString *s = [NSMutableString string];
            NSUInteger i;
            for (i = 1; i < count; ++i) {
                NSString *entry = [fields objectAtIndex:i];
                if ([entry length] > 0)
                    [s appendString:[NSString stringWithFormat:@"%@\n", entry]];
            }
            
            if (0 == [s length])
                continue;
            
            NSString *title = [fields objectAtIndex:0];
			NSMutableAttributedString *attributedBody = [[[NSMutableAttributedString alloc] initWithString:s attributes:[[GlobalPrefs defaultPrefs] noteBodyAttributes]] autorelease];
			[attributedBody addLinkAttributesForRange:NSMakeRange(0, [attributedBody length])];
			
            NoteObject *note = [[[NoteObject alloc] initWithNoteBody:attributedBody title:title uniqueFilename:nil format:SingleDatabaseFormat] autorelease];
			if (note) {
				CFAbsoluteTime now = CFAbsoluteTimeGetCurrent();
				[note setDateAdded:now];
				[note setDateModified:now];
				[notes addObject:note];
			}
        }
    }
	[contents release];
    
    return (notes);
}
@end