/* 

 * 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 "AIWebkitMessageViewStyle.h"

#import <AIUtilities/AIColorAdditions.h>

#import <AIUtilities/AIStringAdditions.h>

#import <AIUtilities/AIDateFormatterAdditions.h>

#import <AIUtilities/AIMutableStringAdditions.h>

#import <Adium/AIAccount.h>

#import <Adium/AIChat.h>

#import <Adium/AIContentTopic.h>

#import <Adium/AIContentContext.h>

#import <Adium/AIContentMessage.h>

#import <Adium/AIContentNotification.h>

#import <Adium/AIContentObject.h>

#import <Adium/AIContentStatus.h>

#import <Adium/AIHTMLDecoder.h>

#import <Adium/AIListObject.h>

#import <Adium/AIListContact.h>

#import <Adium/AIService.h>

#import <Adium/ESFileTransfer.h>

#import <Adium/AIServiceIcons.h>

#import <Adium/AIContentControllerProtocol.h>

#import <Adium/AIStatusIcons.h>

//

#define LEGACY_VERSION_THRESHOLD		3	//Styles older than this version are considered legacy

#define MAX_KNOWN_WEBKIT_VERSION        4   //Styles newer than this version are unknown entities

//

#define KEY_WEBKIT_VERSION				@"MessageViewVersion"

#define KEY_WEBKIT_VERSION_MIN			@"MessageViewVersion_MinimumCompatible"

//BOM scripts for appending content.

#define APPEND_MESSAGE_WITH_SCROLL		@"checkIfScrollToBottomIsNeeded(); appendMessage(\"%@\"); scrollToBottomIfNeeded();"

#define APPEND_NEXT_MESSAGE_WITH_SCROLL	@"checkIfScrollToBottomIsNeeded(); appendNextMessage(\"%@\"); scrollToBottomIfNeeded();"

#define APPEND_MESSAGE					@"appendMessage(\"%@\");"

#define APPEND_NEXT_MESSAGE				@"appendNextMessage(\"%@\");"

#define APPEND_MESSAGE_NO_SCROLL		@"appendMessageNoScroll(\"%@\");"

#define	APPEND_NEXT_MESSAGE_NO_SCROLL	@"appendNextMessageNoScroll(\"%@\");"

#define REPLACE_LAST_MESSAGE			@"replaceLastMessage(\"%@\");"

#define TOPIC_MAIN_DIV					@"<div id=\"topic\"></div>"

// We set back, when the user finishes editing, the correct topic, which wipes out the existance of the span before. We don't need to undo the dbl click action.

#define TOPIC_INDIVIDUAL_WRAPPER		@"<span id=\"topicEdit\" ondblclick=\"this.setAttribute('contentEditable', true); this.focus();\">%@</span>"

@interface NSString (NewSnowLeopardMethods)

- (NSComparisonResult)localizedStandardCompare:(NSString *)string;

@end

@interface NSMutableString (AIKeywordReplacementAdditions)

- (void) replaceKeyword:(NSString *)word withString:(NSString *)newWord;

- (void) safeReplaceCharactersInRange:(NSRange)range withString:(NSString *)newWord;

@end

@implementation NSMutableString (AIKeywordReplacementAdditions)

- (void) replaceKeyword:(NSString *)keyWord withString:(NSString *)newWord

{

	if(!keyWord) return;

	if(!newWord) newWord = @"";

	[self replaceOccurrencesOfString:keyWord

						  withString:newWord

							 options:NSLiteralSearch

							   range:NSMakeRange(0.0f, [self length])];

}

- (void) safeReplaceCharactersInRange:(NSRange)range withString:(NSString *)newWord

{

	if (range.location == NSNotFound || range.length == 0) return;

	if (!newWord) [self deleteCharactersInRange:range];

	else [self replaceCharactersInRange:range withString:newWord];

}

@end

//The old code built the paths itself, which follows the filesystem's case sensitivity, so some noobs named stuff wrong. 

//NSBundle is always case sensitive, so those styles broke (they were already broken on case sensitive hfsx)

//These methods only check for the all-lowercase variant, so are not suitable for general purpose use.

@interface NSBundle (StupidCompatibilityHack)

- (NSString *)semiCaseInsensitivePathForResource:(NSString *)res ofType:(NSString *)type;

- (NSString *)semiCaseInsensitivePathForResource:(NSString *)res ofType:(NSString *)type inDirectory:(NSString *)dirpath;

@end

@implementation NSBundle (StupidCompatibilityHack)

- (NSString *)semiCaseInsensitivePathForResource:(NSString *)res ofType:(NSString *)type

{

	NSString *path = [self pathForResource:res ofType:type];

	if(!path)

		path = [self pathForResource:[res lowercaseString] ofType:type];

	return path;

}

- (NSString *)semiCaseInsensitivePathForResource:(NSString *)res ofType:(NSString *)type inDirectory:(NSString *)dirpath

{

	NSString *path = [self pathForResource:res ofType:type inDirectory:dirpath];

	if(!path)

		path = [self pathForResource:[res lowercaseString] ofType:type inDirectory:dirpath];

	return path;

}

@end

@interface AIWebkitMessageViewStyle ()

- (id)initWithBundle:(NSBundle *)inBundle;

- (void)_loadTemplates;

- (void)releaseResources;

- (NSMutableString *)_escapeStringForPassingToScript:(NSMutableString *)inString;

- (NSString *)noVariantName;

- (NSString *)iconPathForFileTransfer:(ESFileTransfer *)inObject;

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

@end

@implementation AIWebkitMessageViewStyle

@synthesize activeVariant;

+ (id)messageViewStyleFromBundle:(NSBundle *)inBundle

{

	return [[[self alloc] initWithBundle:inBundle] autorelease];

}

+ (id)messageViewStyleFromPath:(NSString *)path

{

	NSBundle *styleBundle = [NSBundle bundleWithPath:[path stringByExpandingBundlePath]];

	if(styleBundle)

		return [[[self alloc] initWithBundle:styleBundle] autorelease];

	return nil;

}

/*!

 *	@brief Initialize

 */

- (id)initWithBundle:(NSBundle *)inBundle

{

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

		styleBundle = [inBundle retain];

		stylePath = [[styleBundle resourcePath] retain];

		if ([self reloadStyle] == FALSE) {

            [self release];

            return nil;

        }

	}

	return self;

}

- (BOOL) reloadStyle

{

	[self releaseResources];

	/* Our styles are versioned so we can change how they work without breaking compatibility.

	 *

	 * Version 0: Initial Webkit Version

	 * Version 1: Template.html now handles all scroll-to-bottom functionality.  It is no longer required to call the

	 *            scrollToBottom functions when inserting content.

	 * Version 2: No significant changes

	 * Version 3: main.css is no longer a separate style, it now serves as the base stylesheet and is imported by default.

	 *            The default variant is now a separate file in /variants like all other variants.

	 *			  Template.html now includes appendMessageNoScroll() and appendNextMessageNoScroll() which behave

	 *				the same as appendMessage() and appendNextMessage() in Versions 1 and 2 but without scrolling.

	 * Version 4: Template.html now includes replaceLastMessage()

	 *            Template.html now defines actionMessageUserName and actionMessageBody for display of /me (actions).

	 *				 If the style provides a custom Template.html, these classes must be defined.

	 *				 CSS can be used to customize the appearance of actions.

	 *			  HTML filters in are now supported in Adium's content filter system; filters can assume Version 4 or later.

	 */

	styleVersion = [[styleBundle objectForInfoDictionaryKey:KEY_WEBKIT_VERSION] integerValue];

    /* Refuse to load a version whose minimum compatible version is greater than the latest version we know about; that

     * indicates this is a style FROM THE FUTURE, and we can't risk corrupting our own timeline.

     */

    NSInteger minimumCompatibleVersion = [[styleBundle objectForInfoDictionaryKey:KEY_WEBKIT_VERSION_MIN] integerValue];

    if (minimumCompatibleVersion && (minimumCompatibleVersion > MAX_KNOWN_WEBKIT_VERSION)) {

        return NO;

    }

    //Default behavior

	allowTextBackgrounds = YES;

	//Pre-fetch our templates

	[self _loadTemplates];

	//Style flags

	allowsCustomBackground = ![[styleBundle objectForInfoDictionaryKey:@"DisableCustomBackground"] boolValue];

	transparentDefaultBackground = [[styleBundle objectForInfoDictionaryKey:@"DefaultBackgroundIsTransparent"] boolValue];

	combineConsecutive = ![[styleBundle objectForInfoDictionaryKey:@"DisableCombineConsecutive"] boolValue];

	NSNumber *tmpNum = [styleBundle objectForInfoDictionaryKey:@"ShowsUserIcons"];

	allowsUserIcons = (tmpNum ? [tmpNum boolValue] : YES);

	//User icon masking

	NSString *tmpName = [styleBundle objectForInfoDictionaryKey:KEY_WEBKIT_USER_ICON_MASK];

	if (tmpName) userIconMask = [[NSImage alloc] initWithContentsOfFile:[stylePath stringByAppendingPathComponent:tmpName]];

	NSNumber *allowsColorsNumber = [styleBundle objectForInfoDictionaryKey:@"AllowTextColors"];

	allowsColors = (allowsColorsNumber ? [allowsColorsNumber boolValue] : YES);

    return YES;

}

/*!

 *  @brief release everything we loaded from the style bundle

 */

- (void)releaseResources

{

	//Templates

	[headerHTML release];

	[footerHTML release];

	[baseHTML release];

	[contentHTML release];

	[contentInHTML release];

	[nextContentInHTML release];

	[contextInHTML release];

	[nextContextInHTML release];

	[contentOutHTML release];

	[nextContentOutHTML release];

	[contextOutHTML release];

	[nextContextOutHTML release];

	[statusHTML release];	

	[fileTransferHTML release];

	[topicHTML release];

	[customBackgroundPath release];

	[customBackgroundColor release];

	[userIconMask release];

}

/*!

 *	@brief Deallocate

 */

- (void)dealloc

{	

	[styleBundle release];

	[stylePath release];

	[self releaseResources];

	[timeStampFormatter release];

	[[NSDistributedNotificationCenter defaultCenter] removeObserver: self];

	[statusIconPathCache release];

	[timeFormatterCache release];

	self.activeVariant = nil;

	[super dealloc];

}

@synthesize bundle = styleBundle;

- (BOOL)isLegacy

{

	return styleVersion < LEGACY_VERSION_THRESHOLD;

}

#pragma mark Settings

@synthesize allowsCustomBackground, allowsUserIcons, allowsColors, userIconMask;

- (NSArray *)validSenderColors

{

	if(!checkedSenderColors) {

		NSURL *url = [NSURL fileURLWithPath:[stylePath stringByAppendingPathComponent:@"Incoming/SenderColors.txt"]];

		NSString *senderColorsFile = [NSString stringWithContentsOfURL:url encoding:NSUTF8StringEncoding error:NULL];

		if(senderColorsFile)

			validSenderColors = [[senderColorsFile componentsSeparatedByString:@":"] retain];

		checkedSenderColors = YES;

	}

	return validSenderColors;

}

- (BOOL)isBackgroundTransparent

{

	//Our custom background is only transparent if the user has set a custom color with an alpha component less than 1.0

	return ((!customBackgroundColor && transparentDefaultBackground) ||

		   (customBackgroundColor && [customBackgroundColor alphaComponent] < 0.99));

}

- (NSString *)defaultFontFamily

{

	NSString *defaultFontFamily = [styleBundle objectForInfoDictionaryKey:KEY_WEBKIT_DEFAULT_FONT_FAMILY];

	if (!defaultFontFamily) defaultFontFamily = [[NSFont systemFontOfSize:0] familyName];

	return defaultFontFamily;

}

- (NSNumber *)defaultFontSize

{

	NSNumber *defaultFontSize = [styleBundle objectForInfoDictionaryKey:KEY_WEBKIT_DEFAULT_FONT_SIZE];

	if (!defaultFontSize) defaultFontSize = [NSNumber numberWithInteger:[[NSFont systemFontOfSize:0] pointSize]];

	return defaultFontSize;

}

- (BOOL)hasHeader

{

	return headerHTML && [headerHTML length];

}

- (BOOL)hasTopic

{

	return topicHTML && [topicHTML length];

}

#pragma mark Behavior

- (void)setDateFormat:(NSString *)format

{

	if (!format || [format length] == 0) {

		format = [NSDateFormatter localizedDateFormatStringShowingSeconds:NO showingAMorPM:NO];

	}

	[timeStampFormatter release];

	if ([format rangeOfString:@"%"].location != NSNotFound) {

		/* Support strftime-style format strings, which old message styles may use */

		timeStampFormatter = [[NSDateFormatter alloc] initWithDateFormat:format allowNaturalLanguage:NO];

	} else {

		timeStampFormatter = [[NSDateFormatter alloc] init];

		[timeStampFormatter	setFormatterBehavior:NSDateFormatterBehavior10_4];

		[timeStampFormatter setDateFormat:format];

	}

}

- (void) flushTimeFormatterCache:(id)dummy {

	[timeFormatterCache removeAllObjects];

}

@synthesize allowTextBackgrounds, customBackgroundType, customBackgroundColor, showIncomingMessageColors=showIncomingColors, showIncomingMessageFonts=showIncomingFonts, customBackgroundPath, nameFormat, useCustomNameFormat, showHeader, showUserIcons;

//Templates ------------------------------------------------------------------------------------------------------------

#pragma mark Templates

- (NSString *)baseTemplateForChat:(AIChat *)chat

{

	NSMutableString	*templateHTML;

	// If this is a group chat, we want to include a topic.

	// Otherwise, if the header is shown, use it.

	NSString *headerContent = @"";

	if (showHeader) {

		if (chat.isGroupChat) {

			headerContent = (chat.supportsTopic ? TOPIC_MAIN_DIV : @"");

		} else if (headerHTML) {

			headerContent = headerHTML;

		}

	}

	//Old styles may be using an old custom 4 parameter baseHTML.  Styles version 3 and higher should

	//be using the bundled (or a custom) 5 parameter baseHTML.

	if ((styleVersion < 3) && usingCustomTemplateHTML) {

		templateHTML = [NSMutableString stringWithFormat:baseHTML,						//Template

			[[NSURL fileURLWithPath:stylePath] absoluteString],							//Base path

			[self pathForVariant:self.activeVariant],									//Variant path

			headerContent,

			(footerHTML ? footerHTML : @"")];

	} else {		

		templateHTML = [NSMutableString stringWithFormat:baseHTML,						//Template

			[[NSURL fileURLWithPath:stylePath] absoluteString],							//Base path

			styleVersion < 3 ? @"" : @"@import url( \"main.css\" );",					//Import main.css for new enough styles

			[self pathForVariant:self.activeVariant],									//Variant path

			headerContent,

			(footerHTML ? footerHTML : @"")];

	}

	return [self fillKeywordsForBaseTemplate:templateHTML chat:chat];

}

- (NSString *)templateForContent:(AIContentObject *)content similar:(BOOL)contentIsSimilar

{

	NSString	*template;

	//Get the correct template for what we're inserting

	if ([[content type] isEqualToString:CONTENT_MESSAGE_TYPE]) {

		if ([content isOutgoing]) {

			template = (contentIsSimilar ? nextContentOutHTML : contentOutHTML);

		} else {

			template = (contentIsSimilar ? nextContentInHTML : contentInHTML);

		}

	} else if ([[content type] isEqualToString:CONTENT_CONTEXT_TYPE]) {

		if ([content isOutgoing]) {

			template = (contentIsSimilar ? nextContextOutHTML : contextOutHTML);

		} else {

			template = (contentIsSimilar ? nextContextInHTML : contextInHTML);

		}

	} else if([[content type] isEqualToString:CONTENT_FILE_TRANSFER_TYPE]) {

		template = [[fileTransferHTML mutableCopy] autorelease];

	} else if ([[content type] isEqualToString:CONTENT_TOPIC_TYPE]) {

		template = topicHTML;

	}

	else {

		template = statusHTML;

	}

	return template;

}

- (NSString *)completedTemplateForContent:(AIContentObject *)content similar:(BOOL)contentIsSimilar

{

	NSMutableString *mutableTemplate = [[self templateForContent:content similar:contentIsSimilar] mutableCopy];

	if (mutableTemplate)

		[self fillKeywords:mutableTemplate forContent:content similar:contentIsSimilar];

	return [mutableTemplate autorelease];

}

/*!

 *	@brief Pre-fetch all the style templates

 *

 *	This needs to be called before either baseTemplate or templateForContent is called

 */

- (void)_loadTemplates

{		

	//Load the style's templates

	//We can't use NSString's initWithContentsOfFile here.  HTML files are interpreted in the defaultCEncoding

	//(which varies by system) when read that way.  We want to always interpret the files as UTF8.

	headerHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Header" ofType:@"html"]] retain];

	footerHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Footer" ofType:@"html"]] retain];

	topicHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Topic" ofType:@"html"]] retain];

	baseHTML = [NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Template" ofType:@"html"]];

	//Starting with version 1, styles can choose to not include template.html.  If the template is not included 

	//Adium's default will be used.  This is preferred since any future template updates will apply to the style

	if ((!baseHTML || [baseHTML length] == 0) && styleVersion >= 1) {		

		baseHTML = [NSString stringWithContentsOfUTF8File:[[NSBundle bundleForClass:[self class]] semiCaseInsensitivePathForResource:@"Template" ofType:@"html"]];

		usingCustomTemplateHTML = NO;

	} else {

		usingCustomTemplateHTML = YES;

		NSAssert(baseHTML != nil, @"The impossible happened!");

		if ([baseHTML rangeOfString:@"function imageCheck()" options:NSLiteralSearch].location != NSNotFound) {

			/* This doesn't quite fix image swapping on styles with broken image swapping due to custom HTML templates,

			 * but it improves it. For some reason, the result of using our normal template.html functions is that 

			 * clicking works once, then the text doesn't allow a return click. This is an improvement compared

			 * to fully broken behavior in which the return click shows a missing-image placeholder.

			 */

			NSMutableString *imageSwapFixedBaseHTML = [[baseHTML mutableCopy] autorelease];

			[imageSwapFixedBaseHTML replaceOccurrencesOfString:

			 @"		function imageCheck() {\n"

			 "			node = event.target;\n"

			 "			if(node.tagName == 'IMG' && node.alt) {\n"

			 "				a = document.createElement('a');\n"

			 "				a.setAttribute('onclick', 'imageSwap(this)');\n"

			 "				a.setAttribute('src', node.src);\n"

			 "				text = document.createTextNode(node.alt);\n"

			 "				a.appendChild(text);\n"

			 "				node.parentNode.replaceChild(a, node);\n"

			 "			}\n"

			 "		}"

													withString:

			 @"		function imageCheck() {\n"

			 "			var node = event.target;\n"

			 "			if(node.tagName.toLowerCase() == 'img' && !client.zoomImage(node) && node.alt) {\n"

			 "				var a = document.createElement('a');\n"

			 "				a.setAttribute('onclick', 'imageSwap(this)');\n"

			 "				a.setAttribute('src', node.getAttribute('src'));\n"

			 "				a.className = node.className;\n"

			 "				var text = document.createTextNode(node.alt);\n"

			 "				a.appendChild(text);\n"

			 "				node.parentNode.replaceChild(a, node);\n"

			 "			}\n"

			 "		}"

													   options:NSLiteralSearch];

			[imageSwapFixedBaseHTML replaceOccurrencesOfString:

			 @"		function imageSwap(node) {\n"

			 "			img = document.createElement('img');\n"

			 "			img.setAttribute('src', node.src);\n"

			 "			img.setAttribute('alt', node.firstChild.nodeValue);\n"

			 "			node.parentNode.replaceChild(img, node);\n"

			 "			alignChat();\n"

			 "		}"

													withString:

			 @"		function imageSwap(node) {\n"

			 "			var shouldScroll = nearBottom();\n"

			 "			//Swap the image/text\n"

			 "			var img = document.createElement('img');\n"

			 "			img.setAttribute('src', node.getAttribute('src'));\n"

			 "			img.setAttribute('alt', node.firstChild.nodeValue);\n"

			 "			img.className = node.className;\n"

			 "			node.parentNode.replaceChild(img, node);\n"

			 "			\n"

			 "			alignChat(shouldScroll);\n"

			 "		}"

													   options:NSLiteralSearch];

			/* Now for ones which don't call alignChat() */

			[imageSwapFixedBaseHTML replaceOccurrencesOfString:

			 @"		function imageSwap(node) {\n"

			 "			img = document.createElement('img');\n"

			 "			img.setAttribute('src', node.src);\n"

			 "			img.setAttribute('alt', node.firstChild.nodeValue);\n"

			 "			node.parentNode.replaceChild(img, node);\n"

			 "		}"

													withString:

			 @"		function imageSwap(node) {\n"

			 "			var shouldScroll = nearBottom();\n"

			 "			//Swap the image/text\n"

			 "			var img = document.createElement('img');\n"

			 "			img.setAttribute('src', node.getAttribute('src'));\n"

			 "			img.setAttribute('alt', node.firstChild.nodeValue);\n"

			 "			img.className = node.className;\n"

			 "			node.parentNode.replaceChild(img, node);\n"

			 "		}"

													   options:NSLiteralSearch];

			baseHTML = imageSwapFixedBaseHTML;

		}

	}

	[baseHTML retain];

	//Content Templates

	contentHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Content" ofType:@"html"]] retain];

	contentInHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Content" ofType:@"html" inDirectory:@"Incoming"]] retain];

	nextContentInHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"NextContent" ofType:@"html" inDirectory:@"Incoming"]] retain];

	contentOutHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Content" ofType:@"html" inDirectory:@"Outgoing"]] retain];

	nextContentOutHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"NextContent" ofType:@"html" inDirectory:@"Outgoing"]] retain];

	//Message history

	contextInHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Context" ofType:@"html" inDirectory:@"Incoming"]] retain];

	nextContextInHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"NextContext" ofType:@"html" inDirectory:@"Incoming"]] retain];

	contextOutHTML = [[NSString stringWithContentsOfUTF8File:[styleBundle semiCaseInsensitivePathForResource:@"Context" ofType:@"html" inDirectory:@"Outgoing"]] retain];