/* 

 * Adium is the legal property of its developers, whose names are listed in the copyright file included

 * with this source distribution.

 * 

 * 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.

 */

#import "AIWebKitMessageViewController.h"

#import "AIWebKitMessageViewStyle.h"

#import "AIWebKitMessageViewPlugin.h"

#import "ESWebKitMessageViewPreferences.h"

#import "AIWebKitDelegate.h"

#import "ESFileTransferRequestPromptController.h"

#import "ESWebView.h"

#import <Adium/AIContactControllerProtocol.h>

#import <Adium/AIContentControllerProtocol.h>

#import <Adium/AIMenuControllerProtocol.h>

#import <Adium/AIFileTransferControllerProtocol.h>

#import <Adium/AIAccount.h>

#import <Adium/AIChat.h>

#import <Adium/AIContentTopic.h>

#import <Adium/AIContentContext.h>

#import <Adium/AIContentObject.h>

#import <Adium/AIContentEvent.h>

#import <Adium/AIEmoticon.h>

#import <Adium/AIListContact.h>

#import <Adium/AIMetaContact.h>

#import <Adium/AIListObject.h>

#import <Adium/AIService.h>

#import <Adium/ESFileTransfer.h>

#import <Adium/ESTextAndButtonsWindowController.h>

#import <Adium/AIHTMLDecoder.h>

#import <AIUtilities/AIArrayAdditions.h>

#import <AIUtilities/AIColorAdditions.h>

#import <AIUtilities/AIDateFormatterAdditions.h>

#import <AIUtilities/AIFileManagerAdditions.h>

#import <AIUtilities/AIImageAdditions.h>

#import <AIUtilities/AIMenuAdditions.h>

#import <AIUtilities/AIMutableStringAdditions.h>

#import <AIUtilities/AIPasteboardAdditions.h>

#import <AIUtilities/AIStringAdditions.h>

#import <AIUtilities/AIAttributedStringAdditions.h>

#import <AIUtilities/JVMarkedScroller.h>

#import <objc/objc-runtime.h>

#define KEY_WEBKIT_CHATS_USING_CACHED_ICON @"WebKit:Chats Using Cached Icon"

#define USE_FASTER_BUT_BUGGY_WEBKIT_PREFERENCE_CHANGE_HANDLING FALSE

#define TEMPORARY_FILE_PREFIX	@"TEMP"

@interface AIWebKitMessageViewController ()

- (id)initForChat:(AIChat *)inChat withPlugin:(AIWebKitMessageViewPlugin *)inPlugin;

- (void)_initWebView;

- (void)_primeWebViewAndReprocessContent:(BOOL)reprocessContent;

- (void)_updateWebViewForCurrentPreferences;

- (void)_updateVariantWithoutPrimingView;

- (void)processQueuedContent;

- (void)_processContentObject:(AIContentObject *)content willAddMoreContentObjects:(BOOL)willAddMoreContentObjects;

- (void)_appendContent:(AIContentObject *)content similar:(BOOL)contentIsSimilar willAddMoreContentObjects:(BOOL)willAddMoreContentObjects replaceLastContent:(BOOL)replaceLastContent;

- (NSString *)_webKitBackgroundImagePathForUniqueID:(NSInteger)uniqueID;

- (NSString *)_webKitUserIconPathForObject:(AIListObject *)inObject;

- (void)releaseCurrentWebKitUserIconForObject:(AIListObject *)inObject;

- (void)releaseAllCachedIcons;

- (void)updateUserIconForObject:(AIListObject *)inObject;

- (void)userIconForObjectDidChange:(AIListObject *)inObject;

- (void)updateServiceIcon;

- (void)updateTopic;

- (void)participatingListObjectsChanged:(NSNotification *)notification;

- (void)sourceOrDestinationChanged:(NSNotification *)notification;

- (BOOL)shouldHandleDragWithPasteboard:(NSPasteboard *)pasteboard;

- (void)enqueueContentObject:(AIContentObject *)contentObject;

- (void)debugLog:(NSString *)message;

- (void)processQueuedContent;

- (NSString *)webviewSource;

- (void) setIsGroupChat:(BOOL) flag;

- (void)setupMarkedScroller;

- (JVMarkedScroller *)markedScroller;

- (NSNumber *)currentOffsetHeight;

- (void)markCurrentLocation;

@end

@interface DOMDocument (FutureWebKitPublicMethodsIKnow)

- (DOMNodeList *)getElementsByClassName:(NSString *)className;

- (DOMNodeList *)querySelectorAll:(NSString *)selectors; // We require 10.5.8/Safari 4, all is well!

@end

static NSArray *draggedTypes = nil;

@implementation AIWebKitMessageViewController

+ (AIWebKitMessageViewController *)messageDisplayControllerForChat:(AIChat *)inChat withPlugin:(AIWebKitMessageViewPlugin *)inPlugin

{

    return [[[self alloc] initForChat:inChat withPlugin:inPlugin] autorelease];

}

- (id)initForChat:(AIChat *)inChat withPlugin:(AIWebKitMessageViewPlugin *)inPlugin

{

    //init

    if ((self = [super init])) {		

		[self _initWebView];

		delegateProxy = [AIWebKitDelegate sharedWebKitDelegate];

		chat = [inChat retain];

		plugin = [inPlugin retain];

		contentQueue = [[NSMutableArray alloc] init];

		objectIconPathDict = [[NSMutableDictionary alloc] init];

		objectsWithUserIconsArray = [[NSMutableArray alloc] init];

		shouldReflectPreferenceChanges = NO;

		storedContentObjects = nil;

		//Observe preference changes.

		[adium.preferenceController registerPreferenceObserver:self forGroup:PREF_GROUP_WEBKIT_REGULAR_MESSAGE_DISPLAY];

		[adium.preferenceController registerPreferenceObserver:self forGroup:PREF_GROUP_WEBKIT_GROUP_MESSAGE_DISPLAY];

		[adium.preferenceController registerPreferenceObserver:self forGroup:PREF_GROUP_WEBKIT_BACKGROUND_IMAGES];

		//Set ourselves up initially.

		[self _updateWebViewForCurrentPreferences];

		//Observe participants list changes

		[[NSNotificationCenter defaultCenter] addObserver:self 

									   selector:@selector(participatingListObjectsChanged:)

										   name:Chat_ParticipatingListObjectsChanged 

										 object:inChat];

		//Observe source/destination changes

		[[NSNotificationCenter defaultCenter] addObserver:self 

									   selector:@selector(sourceOrDestinationChanged:)

										   name:Chat_SourceChanged 

										 object:inChat];

		[[NSNotificationCenter defaultCenter] addObserver:self 

									   selector:@selector(sourceOrDestinationChanged:)

										   name:Chat_DestinationChanged 

										 object:inChat];

		//Observe content additons

		[[NSNotificationCenter defaultCenter] addObserver:self 

									   selector:@selector(contentObjectAdded:)

										   name:Content_ContentObjectAdded 

										 object:inChat];

		[[NSNotificationCenter defaultCenter] addObserver:self 

									   selector:@selector(chatDidFinishAddingUntrackedContent:)

										   name:Content_ChatDidFinishAddingUntrackedContent 

										 object:inChat];

		[[NSNotificationCenter defaultCenter] addObserver:self

									   selector:@selector(customEmoticonUpdated:)

										   name:@"AICustomEmoticonUpdated"

										 object:inChat];

	}

    return self;

}

- (void)messageViewIsClosing

{

	[webView stopLoading:nil];

	//Stop observing the webview, since it may attempt callbacks shortly after we dealloc

	[delegateProxy removeDelegate:self];

	/* The windowScriptObject retained self when we set it as the client in -[AIWebKitMessageViewController _initWebView]...

	 * Unfortunately, (as of 10.4.9) it won't actually release self until the webView deallocates.  We'll do removeWebScriptKey:

	 * now in case that works properly later, and do the release of webView here rather than in dealloc to work around the bug.

	 */

	[[webView windowScriptObject] removeWebScriptKey:@"client"];

	//Release the web view

	[webView release]; webView = nil;

}

/*!

 * @brief Deallocate

 */

- (void)dealloc

{

	[self releaseAllCachedIcons];

	[plugin release]; plugin = nil;

	[objectsWithUserIconsArray release]; objectsWithUserIconsArray = nil;

	[objectIconPathDict release]; objectIconPathDict = nil;

	//Stop any delayed requests and remove all observers

	[NSObject cancelPreviousPerformRequestsWithTarget:self];

	[adium.preferenceController unregisterPreferenceObserver:self];

	[[NSNotificationCenter defaultCenter] removeObserver:self];

	//Clean up style/variant info

	[messageStyle release]; messageStyle = nil;

	[activeStyle release]; activeStyle = nil;

	[activeVariant release]; activeVariant = nil;

	[preferenceGroup release]; preferenceGroup = nil;

	//Cleanup content processing

	[contentQueue release]; contentQueue = nil;

	[storedContentObjects release]; storedContentObjects = nil;

	[previousContent release]; previousContent = nil;

	//Release the chat

	[chat release]; chat = nil;

	//Release the marked scroller

	[self.markedScroller release];

	[super dealloc];

}

- (void)setShouldReflectPreferenceChanges:(BOOL)inValue

{

	shouldReflectPreferenceChanges = inValue;

	//We'll want to start storing content objects if we're needing to reflect preference changes

	if (shouldReflectPreferenceChanges) {

		if (!storedContentObjects) {

			storedContentObjects = [[NSMutableArray alloc] init];

		}

	} else {

		[storedContentObjects release]; storedContentObjects = nil;

	}

}

- (void)adiumPrint:(id)sender

{	

	WebPreferences* prefs = [webView preferences];

	[prefs setShouldPrintBackgrounds:YES];

	[[[[webView mainFrame] frameView] documentView] print:sender];

}

//WebView --------------------------------------------------------------------------------------------------

#pragma mark WebView

@synthesize messageStyle, messageView = webView;

- (NSView *)messageScrollView

{

	return [[webView mainFrame] frameView];

}

/*!

 * @brief Apply preference changes to our webview

 */

- (void)preferencesChangedForGroup:(NSString *)group key:(NSString *)key object:(AIListObject *)object

					preferenceDict:(NSDictionary *)prefDict firstTime:(BOOL)firstTime

{

	// First time won't occur because preferenceGroup is not yet set. Don't run on the assumption that it is, end early.

	if (!preferenceGroup)

		return;

	if ([group isEqualToString:preferenceGroup]) {

#if USE_FASTER_BUT_BUGGY_WEBKIT_PREFERENCE_CHANGE_HANDLING

		NSString		*variantKey = [plugin styleSpecificKey:@"Variant" forStyle:activeStyle];

		//Variant changes we can apply immediately.  All other changes require us to reload the view

		if (!firstTime && [key isEqualToString:variantKey]) {

			[activeVariant release]; activeVariant = [[prefDict objectForKey:variantKey] retain];

			[self _updateVariantWithoutPrimingView];

		} else if (shouldReflectPreferenceChanges) {

			//Ignore changes related to our background image cache.  These keys are used for storage only and aren't

			//something we need to update in response to.  All other display changes we update our view for.

			if (![key isEqualToString:@"BackgroundCacheUniqueID"] &&

			    ![key isEqualToString:[plugin styleSpecificKey:@"BackgroundCachePath" forStyle:activeStyle]] &&

				![key isEqualToString:KEY_CURRENT_WEBKIT_STYLE_PATH]) {

				[self _updateWebViewForCurrentPreferences];

			}

		}

#else

		if (shouldReflectPreferenceChanges) {

			//Ignore changes related to our background image cache.  These keys are used for storage only and aren't

			//something we need to update in response to.  All other display changes we update our view for.

			if (![key isEqualToString:@"BackgroundCacheUniqueID"] &&

			    ![key isEqualToString:[plugin styleSpecificKey:@"BackgroundCachePath" forStyle:activeStyle]] &&

				(![key isEqualToString:KEY_CURRENT_WEBKIT_STYLE_PATH] || shouldReflectPreferenceChanges)) {

				if (!isUpdatingWebViewForCurrentPreferences) {

					isUpdatingWebViewForCurrentPreferences = YES;

					[self _updateWebViewForCurrentPreferences];

					isUpdatingWebViewForCurrentPreferences = NO;

				}

			}

		}

#endif

	}

	if (([group isEqualToString:PREF_GROUP_WEBKIT_BACKGROUND_IMAGES] && shouldReflectPreferenceChanges)) {

		//If the background image changes, wipe the cache and update for the new image

		[adium.preferenceController setPreference:nil

											 forKey:[plugin styleSpecificKey:@"BackgroundCachePath" forStyle:activeStyle]

											  group:preferenceGroup];	

		if (!isUpdatingWebViewForCurrentPreferences) {

			isUpdatingWebViewForCurrentPreferences = YES;

			[self _updateWebViewForCurrentPreferences];

			isUpdatingWebViewForCurrentPreferences = NO;

		}

	}	

}

/*!

 * @brief Initialiaze the web view

 */

- (void)_initWebView

{

	//Create our webview

	webView = [[ESWebView alloc] initWithFrame:NSMakeRect(0,0,100,100) //Arbitrary frame

									 frameName:nil

									 groupName:nil];

	[webView setAutoresizingMask:(NSViewWidthSizable | NSViewHeightSizable)];

	[delegateProxy addDelegate:self forView:webView];

	[webView setMaintainsBackForwardList:NO];

	if (!draggedTypes) {

		draggedTypes = [[NSArray alloc] initWithObjects:

			NSFilenamesPboardType,

			AIiTunesTrackPboardType,

			NSTIFFPboardType,

			NSPDFPboardType,

			NSPICTPboardType,

			NSHTMLPboardType,

			NSFileContentsPboardType,

			NSRTFPboardType,

			NSStringPboardType,

			NSPostScriptPboardType,

			nil];

	}

	[webView registerForDraggedTypes:draggedTypes];

}

/*!

 * @brief Updates our webview to the current preferences, priming the view

 */

- (void)_updateWebViewForCurrentPreferences

{

	//Cleanup first

	[messageStyle autorelease]; messageStyle = nil;

	[activeStyle release]; activeStyle = nil;

	[activeVariant release]; activeVariant = nil;

	//Load the message style

	messageStyle = [[plugin currentMessageStyleForChat:chat] retain];

	activeStyle = [[[messageStyle bundle] bundleIdentifier] retain];

	preferenceGroup = [[plugin preferenceGroupForChat:chat] retain];

	[webView setPreferencesIdentifier:activeStyle];

	//Get the prefered variant (or the default if a prefered is not available)

	activeVariant = [[adium.preferenceController preferenceForKey:[plugin styleSpecificKey:@"Variant" forStyle:activeStyle]

															  group:preferenceGroup] retain];

	if (!activeVariant) activeVariant = [[messageStyle defaultVariant] retain];

	if (!activeVariant) {

		/* If the message style doesn't specify a default variant, choose the first one.

		 * Note: Old styles (styleVersion < 3) will always report a variant for defaultVariant.

		 */

		NSArray *availableVariants = [messageStyle availableVariants];

		if ([availableVariants count]) {

			activeVariant = [[availableVariants objectAtIndex:0] retain];

		}

	}

	NSDictionary *prefDict = [adium.preferenceController preferencesForGroup:preferenceGroup];

	//Update message style behavior: XXX move this somewhere not per-chat

	[messageStyle setShowUserIcons:[[prefDict objectForKey:KEY_WEBKIT_SHOW_USER_ICONS] boolValue]];

	[messageStyle setShowHeader:[[prefDict objectForKey:KEY_WEBKIT_SHOW_HEADER] boolValue]];

	[messageStyle setUseCustomNameFormat:[[prefDict objectForKey:KEY_WEBKIT_USE_NAME_FORMAT] boolValue]];

	[messageStyle setNameFormat:[[prefDict objectForKey:KEY_WEBKIT_NAME_FORMAT] integerValue]];

	[messageStyle setDateFormat:[prefDict objectForKey:KEY_WEBKIT_TIME_STAMP_FORMAT]];

	[messageStyle setShowIncomingMessageColors:[[prefDict objectForKey:KEY_WEBKIT_SHOW_MESSAGE_COLORS] boolValue]];

	[messageStyle setShowIncomingMessageFonts:[[prefDict objectForKey:KEY_WEBKIT_SHOW_MESSAGE_FONTS] boolValue]];

	//Custom background image

	//Webkit wants to load these from disk, but we have it stuffed in a plist.  So we'll write it out as an image

	//into the cache and have webkit fetch from there.

	NSString	*cachePath = nil;

	if ([[adium.preferenceController preferenceForKey:[plugin styleSpecificKey:@"UseCustomBackground" forStyle:activeStyle]

												  group:preferenceGroup] boolValue]) {

		cachePath = [adium.preferenceController preferenceForKey:[plugin styleSpecificKey:@"BackgroundCachePath" forStyle:activeStyle]

															 group:preferenceGroup];

		if (!cachePath || ![[NSFileManager defaultManager] fileExistsAtPath:cachePath]) {

			NSData	*backgroundImage = [adium.preferenceController preferenceForKey:[plugin styleSpecificKey:@"Background" forStyle:activeStyle]

																				group:PREF_GROUP_WEBKIT_BACKGROUND_IMAGES];

			if (backgroundImage) {

				//Generate a unique cache ID for this image

				NSInteger	uniqueID = [[adium.preferenceController preferenceForKey:@"BackgroundCacheUniqueID"

																		 group:preferenceGroup] integerValue] + 1;

				[adium.preferenceController setPreference:[NSNumber numberWithInteger:uniqueID]

													 forKey:@"BackgroundCacheUniqueID"

													  group:preferenceGroup];

				//Cache the image under that unique ID

				//Since we prefix the filename with TEMP, Adium will automatically clean it up on quit

				cachePath = [self _webKitBackgroundImagePathForUniqueID:uniqueID];

				[backgroundImage writeToFile:cachePath atomically:YES];

				//Remember where we cached it

				[adium.preferenceController setPreference:cachePath

													 forKey:[plugin styleSpecificKey:@"BackgroundCachePath" forStyle:activeStyle]

													  group:preferenceGroup];

			} else {

				cachePath = @""; //No custom image found

			}

		}

		[messageStyle setCustomBackgroundColor:[[adium.preferenceController preferenceForKey:[plugin styleSpecificKey:@"BackgroundColor" forStyle:activeStyle]

																						 group:preferenceGroup] representedColor]];

	} else {

		[messageStyle setCustomBackgroundColor:nil];

	}

	[messageStyle setCustomBackgroundPath:cachePath];

	[messageStyle setCustomBackgroundType:[[adium.preferenceController preferenceForKey:[plugin styleSpecificKey:@"BackgroundType" forStyle:activeStyle]

																					group:preferenceGroup] integerValue]];

	BOOL isBackgroundTransparent = [[self messageStyle] isBackgroundTransparent];

	[webView setTransparent:isBackgroundTransparent];

	NSWindow *win = [webView window];

	if(win)

		[win setOpaque:!isBackgroundTransparent];

	//Update webview font settings

	NSString	*fontFamily = [adium.preferenceController preferenceForKey:[plugin styleSpecificKey:@"FontFamily" forStyle:activeStyle]

																	group:preferenceGroup];

	[webView setFontFamily:(fontFamily ? fontFamily : [messageStyle defaultFontFamily])];

	NSNumber	*fontSize = [adium.preferenceController preferenceForKey:[plugin styleSpecificKey:@"FontSize" forStyle:activeStyle]

																  group:preferenceGroup];

	[[webView preferences] setDefaultFontSize:[(fontSize ? fontSize : [messageStyle defaultFontSize]) integerValue]];

	NSNumber	*minSize = [adium.preferenceController preferenceForKey:KEY_WEBKIT_MIN_FONT_SIZE

																 group:preferenceGroup];

	[[webView preferences] setMinimumFontSize:(minSize ? [minSize integerValue] : 1)];

	//Update our icons before doing any loading

	[self sourceOrDestinationChanged:nil];

	//Prime the webview with the new style/variant and settings, and re-insert all our content back into the view

	[self _primeWebViewAndReprocessContent:YES];	

}

/*!

 * @brief Updates our webview to the currently active varient without refreshing the view

 */

- (void)_updateVariantWithoutPrimingView

{

	//We can only change the variant if the web view is ready.  If it's not ready we wait a bit and try again.

	if (webViewIsReady) {

		[webView stringByEvaluatingJavaScriptFromString:[messageStyle scriptForChangingVariant:activeVariant]];			

	} else {

		[self performSelector:@selector(_updateVariantWithoutPrimingView) withObject:nil afterDelay:NEW_CONTENT_RETRY_DELAY];

	}

}

/*!

 *	@brief Clears the view from displayed messages

 *

 *	Implements the method defined in protocol AIMessageDisplayController

 */

- (void)clearView

{

	[self _primeWebViewAndReprocessContent:NO];

	[self.markedScroller removeAllMarks];

	[previousContent release];

	previousContent = nil;

	nextMessageFocus = NO;

	[chat clearUnviewedContentCount];

}

/*!

 * @brief Primes our webview to the currently active style and variant

 *

 * The webview won't be ready right away, so we flag it as not ready and set ourself as the frame load delegate so

 * it will let us know when it's good to go.  If reprocessContent is NO, all content in the view will be lost.

 */

- (void)_primeWebViewAndReprocessContent:(BOOL)reprocessContent

{

	webViewIsReady = NO;

	//Hack: this will re-set us for all the delegates, but that shouldn't matter

	[delegateProxy addDelegate:self forView:webView];

	[[webView mainFrame] loadHTMLString:[messageStyle baseTemplateWithVariant:activeVariant chat:chat] baseURL:nil];

	if(chat.isGroupChat && chat.supportsTopic) {

		// Force a topic update, so we set our topic appropriately.

		[self updateTopic];

	}

	if (reprocessContent) {

		NSArray	*currentContentQueue;

		//Keep the array of objects waiting to be added, if necessary, to append them after our currently displayed ones

		currentContentQueue = ([contentQueue count] ?

							   [contentQueue copy] :

							   nil);

		//Start from an empty content queue

		[contentQueue removeAllObjects];

		//Add our stored content objects to the content queue

		[contentQueue addObjectsFromArray:storedContentObjects];

		[storedContentObjects removeAllObjects];

		//Add the old content queue back in if necessary

		if (currentContentQueue) {

			[contentQueue addObjectsFromArray:currentContentQueue];

			[currentContentQueue release];

		}

		//We're still holding onto the previousContent from before, which is no longer accurate. Release it.

		[previousContent release]; previousContent = nil;

	}

}

/*!

 * @brief Sets the class 'groupchat' on the #Chat element, to allow styles to modify their appearance based on whether we're in a groupchat

 *

 * If/when we support transforming chats to/from groupchats we'll need to observe that and call this as appropriate

 */

- (void) setIsGroupChat:(BOOL) flag

{

	DOMHTMLElement *chatElement = (DOMHTMLElement *)[[webView mainFrameDocument] getElementById:@"Chat"];

	NSMutableString *chatClassName = [[[chatElement className] mutableCopy] autorelease];

	if (flag == NO)

		[chatClassName replaceOccurrencesOfString:@" groupchat"

									   withString:@""

										  options:NSLiteralSearch

											range:NSMakeRange(0, [chatClassName length])];

	else

		[chatClassName appendString:@" groupchat"];

	[chatElement setClassName:chatClassName];

}

//Content --------------------------------------------------------------------------------------------------------------

#pragma mark Content

/*!

 * @brief Append new content to our processing queue

 */

- (void)contentObjectAdded:(NSNotification *)notification

{

	AIContentObject	*contentObject = [[notification userInfo] objectForKey:@"AIContentObject"];

	[self enqueueContentObject:contentObject];

}

- (void)enqueueContentObject:(AIContentObject *)contentObject

{

	[contentQueue addObject:contentObject];

	/* Immediately update our display if the content requires it.

	* This is NO, for example, when we receive an entire block of message history content so that we can avoid scrolling