/*

 * Copyright (C) 2005, 2006, 2007 Apple, Inc.  All rights reserved.

 *           (C) 2007 Graham Dennis (graham.dennis@gmail.com)

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 *

 * 1.  Redistributions of source code must retain the above copyright

 *     notice, this list of conditions and the following disclaimer. 

 * 2.  Redistributions in binary form must reproduce the above copyright

 *     notice, this list of conditions and the following disclaimer in the

 *     documentation and/or other materials provided with the distribution. 

 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of

 *     its contributors may be used to endorse or promote products derived

 *     from this software without specific prior written permission. 

 *

 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY

 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY

 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

#import "DumpRenderTree.h"

#import "EditingDelegate.h"

#import "EventSendingController.h"

#import "FrameLoadDelegate.h"

#import "LayoutTestController.h"

#import "NavigationController.h"

#import "ObjCPlugin.h"

#import "ObjCPluginFunction.h"

#import "PolicyDelegate.h"

#import "ResourceLoadDelegate.h"

#import "UIDelegate.h"

#import "WorkQueue.h"

#import "WorkQueueItem.h"

#import <ApplicationServices/ApplicationServices.h> // for CMSetDefaultProfileBySpace

#import <CoreFoundation/CoreFoundation.h>

#import <JavaScriptCore/Assertions.h>

#import <JavaScriptCore/JavaScriptCore.h>

#import <WebKit/DOMElementPrivate.h>

#import <WebKit/DOMExtensions.h>

#import <WebKit/DOMRange.h>

#import <WebKit/WebBackForwardList.h>

#import <WebKit/WebCoreStatistics.h>

#import <WebKit/WebDataSource.h>

#import <WebKit/WebDocumentPrivate.h>

#import <WebKit/WebEditingDelegate.h>

#import <WebKit/WebFrameView.h>

#import <WebKit/WebHistory.h>

#import <WebKit/WebHistoryItemPrivate.h>

#import <WebKit/WebPluginDatabase.h>

#import <WebKit/WebPreferences.h>

#import <WebKit/WebPreferencesPrivate.h>

#import <WebKit/WebResourceLoadDelegate.h>

#import <WebKit/WebViewPrivate.h>

#import <getopt.h>

#import <mach-o/getsect.h>

#import <malloc/malloc.h>

#import <objc/objc-runtime.h>                       // for class_poseAs

#import <pthread.h>

#define COMMON_DIGEST_FOR_OPENSSL

#import <CommonCrypto/CommonDigest.h>               // for MD5 functions

@interface DumpRenderTreeWindow : NSWindow

@end

@interface DumpRenderTreePasteboard : NSPasteboard

- (int)declareType:(NSString *)type owner:(id)newOwner;

@end

@interface DumpRenderTreeEvent : NSEvent

@end

@interface LocalPasteboard : NSPasteboard

{

    NSMutableArray *typesArray;

    NSMutableSet *typesSet;

    NSMutableDictionary *dataByType;

    int changeCount;

}

@end

static void runTest(const char *pathOrURL);

static NSString *md5HashStringForBitmap(CGImageRef bitmap);

// Deciding when it's OK to dump out the state is a bit tricky.  All these must be true:

// - There is no load in progress

// - There is no work queued up (see workQueue var, below)

// - waitToDump==NO.  This means either waitUntilDone was never called, or it was called

//       and notifyDone was called subsequently.

// Note that the call to notifyDone and the end of the load can happen in either order.

volatile bool done;

NavigationController* navigationController = 0;

LayoutTestController* layoutTestController = 0;

WebFrame *mainFrame = 0;

// This is the topmost frame that is loading, during a given load, or nil when no load is 

// in progress.  Usually this is the same as the main frame, but not always.  In the case

// where a frameset is loaded, and then new content is loaded into one of the child frames,

// that child frame is the "topmost frame that is loading".

WebFrame *topLoadingFrame = nil;     // !nil iff a load is in progress

CFMutableArrayRef allWindowsRef = 0;

CFMutableSetRef disallowedURLs = 0;

CFRunLoopTimerRef waitToDumpWatchdog = 0;

// Delegates

static FrameLoadDelegate *frameLoadDelegate;

static UIDelegate *uiDelegate;

static EditingDelegate *editingDelegate;

static ResourceLoadDelegate *resourceLoadDelegate;

PolicyDelegate *policyDelegate;

static int dumpPixels;

static int paint;

static int dumpAllPixels;

static int threaded;

static BOOL readFromWindow;

static int testRepaintDefault;

static int repaintSweepHorizontallyDefault;

static int dumpTree = YES;

static BOOL printSeparators;

static NSString *currentTest = nil;

static NSMutableDictionary *localPasteboards;

static WebHistoryItem *prevTestBFItem = nil;  // current b/f item at the end of the previous test

static unsigned char* screenCaptureBuffer;

static CGColorSpaceRef sharedColorSpace;

const unsigned maxViewHeight = 600;

const unsigned maxViewWidth = 800;

static pthread_mutex_t javaScriptThreadsMutex = PTHREAD_MUTEX_INITIALIZER;

static BOOL javaScriptThreadsShouldTerminate;

static const int javaScriptThreadsCount = 4;

static CFMutableDictionaryRef javaScriptThreads()

{

    assert(pthread_mutex_trylock(&javaScriptThreadsMutex) == EBUSY);

    static CFMutableDictionaryRef staticJavaScriptThreads;

    if (!staticJavaScriptThreads)

        staticJavaScriptThreads = CFDictionaryCreateMutable(kCFAllocatorDefault, 0, NULL, NULL);

    return staticJavaScriptThreads;

}

// Loops forever, running a script and randomly respawning, until 

// javaScriptThreadsShouldTerminate becomes true.

void* runJavaScriptThread(void* arg)

{

    const char* const script =

        "var array = [];"

        "for (var i = 0; i < 10; i++) {"

        "    array.push(String(i));"

        "}";

    while(1) {

        JSGlobalContextRef ctx = JSGlobalContextCreate(NULL);

        JSStringRef scriptRef = JSStringCreateWithUTF8CString(script);

        JSValueRef exception = NULL;

        JSEvaluateScript(ctx, scriptRef, NULL, NULL, 0, &exception);

        assert(!exception);

        JSGlobalContextRelease(ctx);

        JSStringRelease(scriptRef);

        JSGarbageCollect(ctx);

        pthread_mutex_lock(&javaScriptThreadsMutex);

        // Check for cancellation.

        if (javaScriptThreadsShouldTerminate) {

            pthread_mutex_unlock(&javaScriptThreadsMutex);

            return 0;

        }

        // Respawn probabilistically.

        if (random() % 5 == 0) {

            pthread_t pthread;

            pthread_create(&pthread, NULL, &runJavaScriptThread, NULL);

            pthread_detach(pthread);

            CFDictionaryRemoveValue(javaScriptThreads(), pthread_self());

            CFDictionaryAddValue(javaScriptThreads(), pthread, NULL);

            pthread_mutex_unlock(&javaScriptThreadsMutex);

            return 0;

        }

        pthread_mutex_unlock(&javaScriptThreadsMutex);

    }

}

static void startJavaScriptThreads()

{

    pthread_mutex_lock(&javaScriptThreadsMutex);

    for (int i = 0; i < javaScriptThreadsCount; i++) {

        pthread_t pthread;

        pthread_create(&pthread, NULL, &runJavaScriptThread, NULL);

        pthread_detach(pthread);

        CFDictionaryAddValue(javaScriptThreads(), pthread, NULL);

    }

    pthread_mutex_unlock(&javaScriptThreadsMutex);

}

static void stopJavaScriptThreads()

{

    pthread_mutex_lock(&javaScriptThreadsMutex);

    javaScriptThreadsShouldTerminate = true;

    pthread_t* pthreads[javaScriptThreadsCount] = { 0 };

    ASSERT(CFDictionaryGetCount(javaScriptThreads()) == javaScriptThreadsCount);

    CFDictionaryGetKeysAndValues(javaScriptThreads(), (const void**)pthreads, 0);

    pthread_mutex_unlock(&javaScriptThreadsMutex);

    for (int i = 0; i < javaScriptThreadsCount; i++) {

        pthread_t* pthread = pthreads[i];

        pthread_join(*pthread, 0);

        free(pthread);

    }

}

static BOOL shouldIgnoreWebCoreNodeLeaks(CFStringRef URLString)

{

    static CFStringRef const ignoreSet[] = {

        // Keeping this infrastructure around in case we ever need it again.

    };

    static const int ignoreSetCount = sizeof(ignoreSet) / sizeof(CFStringRef);

    for (int i = 0; i < ignoreSetCount; i++) {

        CFStringRef ignoreString = ignoreSet[i];

        CFRange range = CFRangeMake(0, CFStringGetLength(URLString));

        CFOptionFlags flags = kCFCompareAnchored | kCFCompareBackwards | kCFCompareCaseInsensitive;

        if (CFStringFindWithOptions(URLString, ignoreString, range, flags, NULL))

            return YES;

    }

    return NO;

}

static CMProfileRef currentColorProfile = 0;

static void restoreColorSpace(int ignored)

{

    if (currentColorProfile) {

        int error = CMSetDefaultProfileByUse(cmDisplayUse, currentColorProfile);

        if (error)

            fprintf(stderr, "Failed to retore previous color profile!  You may need to open System Preferences : Displays : Color and manually restore your color settings.  (Error: %i)", error);

        currentColorProfile = 0;

    }

}

static void crashHandler(int sig)

{

    fprintf(stderr, "%s\n", strsignal(sig));

    restoreColorSpace(0);

    exit(128 + sig);

}

static void activateAhemFont()

{    

    unsigned long fontDataLength;

    char* fontData = getsectdata("__DATA", "Ahem", &fontDataLength);

    if (!fontData) {

        fprintf(stderr, "Failed to locate the Ahem font.\n");

        exit(1);

    }

    ATSFontContainerRef fontContainer;

    OSStatus status = ATSFontActivateFromMemory(fontData, fontDataLength, kATSFontContextLocal, kATSFontFormatUnspecified, NULL, kATSOptionFlagsDefault, &fontContainer);

    if (status != noErr) {

        fprintf(stderr, "Failed to activate the Ahem font.\n");

        exit(1);

    }

}

static void setDefaultColorProfileToRGB()

{

    CMProfileRef genericProfile = (CMProfileRef)[[NSColorSpace genericRGBColorSpace] colorSyncProfile];

    CMProfileRef previousProfile;

    int error = CMGetDefaultProfileByUse(cmDisplayUse, &previousProfile);

    if (error) {

        fprintf(stderr, "Failed to get current color profile.  I will not be able to restore your current profile, thus I'm not changing it.  Many pixel tests may fail as a result.  (Error: %i)\n", error);

        return;

    }

    if (previousProfile == genericProfile)

        return;

    CFStringRef previousProfileName;

    CFStringRef genericProfileName;

    char previousProfileNameString[1024];

    char genericProfileNameString[1024];

    CMCopyProfileDescriptionString(previousProfile, &previousProfileName);

    CMCopyProfileDescriptionString(genericProfile, &genericProfileName);

    CFStringGetCString(previousProfileName, previousProfileNameString, sizeof(previousProfileNameString), kCFStringEncodingUTF8);

    CFStringGetCString(genericProfileName, genericProfileNameString, sizeof(previousProfileNameString), kCFStringEncodingUTF8);

    CFRelease(genericProfileName);

    CFRelease(previousProfileName);

    fprintf(stderr, "\n\nWARNING: Temporarily changing your system color profile from \"%s\" to \"%s\".\n", previousProfileNameString, genericProfileNameString);

    fprintf(stderr, "This allows the WebKit pixel-based regression tests to have consistent color values across all machines.\n");

    fprintf(stderr, "The colors on your screen will change for the duration of the testing.\n\n");

    if ((error = CMSetDefaultProfileByUse(cmDisplayUse, genericProfile)))

        fprintf(stderr, "Failed to set color profile to \"%s\"! Many pixel tests will fail as a result.  (Error: %i)",

            genericProfileNameString, error);

    else {

        currentColorProfile = previousProfile;

        signal(SIGINT, restoreColorSpace);

        signal(SIGHUP, restoreColorSpace);

        signal(SIGTERM, restoreColorSpace);

    }

}

static void* (*savedMalloc)(malloc_zone_t*, size_t);

static void* (*savedRealloc)(malloc_zone_t*, void*, size_t);

static void* checkedMalloc(malloc_zone_t* zone, size_t size)

{

    if (size >= 0x10000000)

        return 0;

    return savedMalloc(zone, size);

}

static void* checkedRealloc(malloc_zone_t* zone, void* ptr, size_t size)

{

    if (size >= 0x10000000)

        return 0;

    return savedRealloc(zone, ptr, size);

}

static void makeLargeMallocFailSilently()

{

    malloc_zone_t* zone = malloc_default_zone();

    savedMalloc = zone->malloc;

    savedRealloc = zone->realloc;

    zone->malloc = checkedMalloc;

    zone->realloc = checkedRealloc;

}

WebView *createWebView()

{

    NSRect rect = NSMakeRect(0, 0, maxViewWidth, maxViewHeight);

    WebView *webView = [[WebView alloc] initWithFrame:rect frameName:nil groupName:@"org.webkit.DumpRenderTree"];

    [webView setUIDelegate:uiDelegate];

    [webView setFrameLoadDelegate:frameLoadDelegate];

    [webView setEditingDelegate:editingDelegate];

    [webView setResourceLoadDelegate:resourceLoadDelegate];

    // Register the same schemes that Safari does

    [WebView registerURLSchemeAsLocal:@"feed"];

    [WebView registerURLSchemeAsLocal:@"feeds"];

    [WebView registerURLSchemeAsLocal:@"feedsearch"];

    // The back/forward cache is causing problems due to layouts during transition from one page to another.

    // So, turn it off for now, but we might want to turn it back on some day.

    [[webView backForwardList] setPageCacheSize:0];

    [webView setContinuousSpellCheckingEnabled:YES];

    // To make things like certain NSViews, dragging, and plug-ins work, put the WebView a window, but put it off-screen so you don't see it.

    // Put it at -10000, -10000 in "flipped coordinates", since WebCore and the DOM use flipped coordinates.

    NSRect windowRect = NSOffsetRect(rect, -10000, [[[NSScreen screens] objectAtIndex:0] frame].size.height - rect.size.height + 10000);

    DumpRenderTreeWindow *window = [[DumpRenderTreeWindow alloc] initWithContentRect:windowRect styleMask:NSBorderlessWindowMask backing:NSBackingStoreBuffered defer:YES];

    [[window contentView] addSubview:webView];

    [window orderBack:nil];

    [window setAutodisplay:NO];

    // For reasons that are not entirely clear, the following pair of calls makes WebView handle its

    // dynamic scrollbars properly. Without it, every frame will always have scrollbars.

    NSBitmapImageRep *imageRep = [webView bitmapImageRepForCachingDisplayInRect:[webView bounds]];

    [webView cacheDisplayInRect:[webView bounds] toBitmapImageRep:imageRep];

    return webView;

}

void testStringByEvaluatingJavaScriptFromString()

{

    // maps expected result <= JavaScript expression

    NSDictionary *expressions = [NSDictionary dictionaryWithObjectsAndKeys:

        @"0", @"0", 

        @"0", @"'0'", 

        @"", @"",

        @"", @"''", 

        @"", @"new String()", 

        @"", @"new String('0')", 

        @"", @"throw 1", 

        @"", @"{ }", 

        @"", @"[ ]", 

        @"", @"//", 

        @"", @"a.b.c", 

        @"", @"(function() { throw 'error'; })()", 

        @"", @"null",

        @"", @"undefined",

        @"true", @"true",

        @"false", @"false",

        nil

    ];

    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

    WebView *webView = [[WebView alloc] initWithFrame:NSZeroRect frameName:@"" groupName:@""];

    NSEnumerator *enumerator = [expressions keyEnumerator];

    id expression;

    while ((expression = [enumerator nextObject])) {

        NSString *expectedResult = [expressions objectForKey:expression];

        NSString *result = [webView stringByEvaluatingJavaScriptFromString:expression];

        assert([result isEqualToString:expectedResult]);

    }

    [webView close];

    [webView release];

    [pool release];

}

void dumpRenderTree(int argc, const char *argv[])

{    

    [NSApplication sharedApplication];

    class_poseAs(objc_getClass("DumpRenderTreePasteboard"), objc_getClass("NSPasteboard"));

    class_poseAs(objc_getClass("DumpRenderTreeEvent"), objc_getClass("NSEvent"));

    struct option options[] = {

        {"dump-all-pixels", no_argument, &dumpAllPixels, YES},

        {"horizontal-sweep", no_argument, &repaintSweepHorizontallyDefault, YES},

        {"notree", no_argument, &dumpTree, NO},

        {"pixel-tests", no_argument, &dumpPixels, YES},

        {"paint", no_argument, &paint, YES},

        {"repaint", no_argument, &testRepaintDefault, YES},

        {"tree", no_argument, &dumpTree, YES},

        {"threaded", no_argument, &threaded, YES},

        {NULL, 0, NULL, 0}

    };

    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];

    [defaults setObject:@"DoubleMax" forKey:@"AppleScrollBarVariant"];

    [defaults setInteger:4 forKey:@"AppleAntiAliasingThreshold"];

    // 2 is the "Medium" font smoothing mode

    [defaults setInteger:2 forKey:@"AppleFontSmoothing"];

    [defaults setInteger:1 forKey:@"AppleAquaColorVariant"];

    [defaults setObject:@"0.709800 0.835300 1.000000" forKey:@"AppleHighlightColor"];

    [defaults setObject:@"0.500000 0.500000 0.500000" forKey:@"AppleOtherHighlightColor"];

    [defaults setObject:[NSArray arrayWithObject:@"en"] forKey:@"AppleLanguages"];

    WebPreferences *preferences = [WebPreferences standardPreferences];

    [preferences setStandardFontFamily:@"Times"];

    [preferences setFixedFontFamily:@"Courier"];

    [preferences setSerifFontFamily:@"Times"];

    [preferences setSansSerifFontFamily:@"Helvetica"];

    [preferences setCursiveFontFamily:@"Apple Chancery"];

    [preferences setFantasyFontFamily:@"Papyrus"];

    [preferences setDefaultFontSize:16];

    [preferences setDefaultFixedFontSize:13];

    [preferences setMinimumFontSize:1];

    [preferences setJavaEnabled:NO];

    [preferences setJavaScriptCanOpenWindowsAutomatically:YES];

    [preferences setEditableLinkBehavior:WebKitEditableLinkOnlyLiveWithShiftKey];

    [preferences setTabsToLinks:NO];

    [preferences setDOMPasteAllowed:YES];

    int option;

    while ((option = getopt_long(argc, (char * const *)argv, "", options, NULL)) != -1)

        switch (option) {

            case '?':   // unknown or ambiguous option

            case ':':   // missing argument

                exit(1);

                break;

        }

    activateAhemFont();

    if (dumpPixels) {

        setDefaultColorProfileToRGB();

        screenCaptureBuffer = (unsigned char *)malloc(maxViewHeight * maxViewWidth * 4);

        sharedColorSpace = CGColorSpaceCreateDeviceRGB();

    }

    localPasteboards = [[NSMutableDictionary alloc] init];

    navigationController = [[NavigationController alloc] init];

    frameLoadDelegate = [[FrameLoadDelegate alloc] init];

    uiDelegate = [[UIDelegate alloc] init];

    editingDelegate = [[EditingDelegate alloc] init];    

    resourceLoadDelegate = [[ResourceLoadDelegate alloc] init];

    policyDelegate = [[PolicyDelegate alloc] init];

    NSString *pwd = [[NSString stringWithUTF8String:argv[0]] stringByDeletingLastPathComponent];

    [WebPluginDatabase setAdditionalWebPlugInPaths:[NSArray arrayWithObject:pwd]];

    [[WebPluginDatabase sharedDatabase] refresh];

    WebView *webView = createWebView();    

    mainFrame = [webView mainFrame];

    NSWindow *window = [webView window];

    makeLargeMallocFailSilently();

    signal(SIGILL, crashHandler);    /* 4:   illegal instruction (not reset when caught) */

    signal(SIGTRAP, crashHandler);   /* 5:   trace trap (not reset when caught) */

    signal(SIGEMT, crashHandler);    /* 7:   EMT instruction */

    signal(SIGFPE, crashHandler);    /* 8:   floating point exception */

    signal(SIGBUS, crashHandler);    /* 10:  bus error */

    signal(SIGSEGV, crashHandler);   /* 11:  segmentation violation */

    signal(SIGSYS, crashHandler);    /* 12:  bad argument to system call */

    signal(SIGPIPE, crashHandler);   /* 13:  write on a pipe with no reader */

    signal(SIGXCPU, crashHandler);   /* 24:  exceeded CPU time limit */

    signal(SIGXFSZ, crashHandler);   /* 25:  exceeded file size limit */

    [[NSURLCache sharedURLCache] removeAllCachedResponses];

    // <rdar://problem/5222911>

    testStringByEvaluatingJavaScriptFromString();