/*

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

 * Copyright (C) 2006 Jonas Witt <jonas.witt@gmail.com>

 * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>

 * Copyright (C) 2006 Alexey Proskuryakov <ap@nypop.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 "config.h"

#import "EventSendingController.h"

#import "DumpRenderTree.h"

#import "DumpRenderTreeDraggingInfo.h"

#import "DumpRenderTreeFileDraggingSource.h"

#import <Carbon/Carbon.h>                           // for GetCurrentEventTime()

#import <WebKit/DOMPrivate.h>

#import <WebKit/WebKit.h>

#import <WebKit/WebViewPrivate.h>

extern "C" void _NSNewKillRingSequence();

enum MouseAction {

    MouseDown,

    MouseUp,

    MouseDragged

};

// Match the DOM spec (sadly the DOM spec does not provide an enum)

enum MouseButton {

    LeftMouseButton = 0,

    MiddleMouseButton = 1,

    RightMouseButton = 2,

    NoMouseButton = -1

};

NSPoint lastMousePosition;

NSPoint lastClickPosition;

int lastClickButton = NoMouseButton;

NSArray *webkitDomEventNames;

NSMutableArray *savedMouseEvents; // mouse events sent between mouseDown and mouseUp are stored here, and then executed at once.

BOOL replayingSavedEvents;

@implementation EventSendingController

+ (void)initialize

{

    webkitDomEventNames = [[NSArray alloc] initWithObjects:

        @"abort",

        @"beforecopy",

        @"beforecut",

        @"beforepaste",

        @"blur",

        @"change",

        @"click",

        @"contextmenu",

        @"copy",

        @"cut",

        @"dblclick",

        @"drag",

        @"dragend",

        @"dragenter",

        @"dragleave",

        @"dragover",

        @"dragstart",

        @"drop",

        @"error",

        @"focus",

        @"input",

        @"keydown",

        @"keypress",

        @"keyup",

        @"load",

        @"mousedown",

        @"mousemove",

        @"mouseout",

        @"mouseover",

        @"mouseup",

        @"mousewheel",

        @"beforeunload",

        @"paste",

        @"readystatechange",

        @"reset",

        @"resize", 

        @"scroll", 

        @"search",

        @"select",

        @"selectstart",

        @"submit", 

        @"textInput", 

        @"textzoomin",

        @"textzoomout",

        @"unload",

        @"zoom",

        nil];

}

+ (BOOL)isSelectorExcludedFromWebScript:(SEL)aSelector

{

    if (aSelector == @selector(beginDragWithFiles:)

            || aSelector == @selector(clearKillRing)

            || aSelector == @selector(contextClick)

            || aSelector == @selector(enableDOMUIEventLogging:)

            || aSelector == @selector(fireKeyboardEventsToElement:)

            || aSelector == @selector(keyDown:withModifiers:withLocation:)

            || aSelector == @selector(leapForward:)

            || aSelector == @selector(mouseDown:withModifiers:)

            || aSelector == @selector(mouseMoveToX:Y:)

            || aSelector == @selector(mouseUp:withModifiers:)

            || aSelector == @selector(scheduleAsynchronousClick)

            || aSelector == @selector(textZoomIn)

            || aSelector == @selector(textZoomOut)

            || aSelector == @selector(zoomPageIn)

            || aSelector == @selector(zoomPageOut)

            || aSelector == @selector(mouseScrollByX:andY:)

            || aSelector == @selector(continuousMouseScrollByX:andY:))

        return NO;

    return YES;

}

+ (BOOL)isKeyExcludedFromWebScript:(const char*)name

{

    if (strcmp(name, "dragMode") == 0)

        return NO;

    return YES;

}

+ (NSString *)webScriptNameForSelector:(SEL)aSelector

{

    if (aSelector == @selector(beginDragWithFiles:))

        return @"beginDragWithFiles";

    if (aSelector == @selector(contextClick))

        return @"contextClick";

    if (aSelector == @selector(enableDOMUIEventLogging:))

        return @"enableDOMUIEventLogging";

    if (aSelector == @selector(fireKeyboardEventsToElement:))

        return @"fireKeyboardEventsToElement";

    if (aSelector == @selector(keyDown:withModifiers:withLocation:))

        return @"keyDown";

    if (aSelector == @selector(leapForward:))

        return @"leapForward";

    if (aSelector == @selector(mouseDown:withModifiers:))

        return @"mouseDown";

    if (aSelector == @selector(mouseUp:withModifiers:))

        return @"mouseUp";

    if (aSelector == @selector(mouseMoveToX:Y:))

        return @"mouseMoveTo";

    if (aSelector == @selector(setDragMode:))

        return @"setDragMode";

    if (aSelector == @selector(mouseScrollByX:andY:))

        return @"mouseScrollBy";

    if (aSelector == @selector(continuousMouseScrollByX:andY:))

        return @"continuousMouseScrollBy";

    return nil;

}

- (id)init

{

    self = [super init];

    if (self)

        dragMode = YES;

    return self;

}

- (void)dealloc

{

    [super dealloc];

}

- (double)currentEventTime

{

    return GetCurrentEventTime() + timeOffset;

}

- (void)leapForward:(int)milliseconds

{

    if (dragMode && leftMouseButtonDown && !replayingSavedEvents) {

        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[EventSendingController instanceMethodSignatureForSelector:@selector(leapForward:)]];

        [invocation setTarget:self];

        [invocation setSelector:@selector(leapForward:)];

        [invocation setArgument:&milliseconds atIndex:2];

        [EventSendingController saveEvent:invocation];

        return;

    }

    timeOffset += milliseconds / 1000.0;

}

- (void)clearKillRing

{

    _NSNewKillRingSequence();

}

static NSEventType eventTypeForMouseButtonAndAction(int button, MouseAction action)

{

    switch (button) {

        case LeftMouseButton:

            switch (action) {

                case MouseDown:

                    return NSLeftMouseDown;

                case MouseUp:

                    return NSLeftMouseUp;

                case MouseDragged:

                    return NSLeftMouseDragged;

            }

        case RightMouseButton:

            switch (action) {

                case MouseDown:

                    return NSRightMouseDown;

                case MouseUp:

                    return NSRightMouseUp;

                case MouseDragged:

                    return NSRightMouseDragged;

            }

        default:

            switch (action) {

                case MouseDown:

                    return NSOtherMouseDown;

                case MouseUp:

                    return NSOtherMouseUp;

                case MouseDragged:

                    return NSOtherMouseDragged;

            }

    }

    assert(0);

    return static_cast<NSEventType>(0);

}

- (void)beginDragWithFiles:(WebScriptObject*)jsFilePaths

{

    assert(!draggingInfo);

    assert([jsFilePaths isKindOfClass:[WebScriptObject class]]);

    NSPasteboard *pboard = [NSPasteboard pasteboardWithUniqueName];

    [pboard declareTypes:[NSArray arrayWithObject:NSFilenamesPboardType] owner:nil];

    NSURL *currentTestURL = [NSURL URLWithString:[[mainFrame webView] mainFrameURL]];

    NSMutableArray *filePaths = [NSMutableArray array];

    for (unsigned i = 0; [[jsFilePaths webScriptValueAtIndex:i] isKindOfClass:[NSString class]]; i++) {

        NSString *filePath = (NSString *)[jsFilePaths webScriptValueAtIndex:i];

        // Have NSURL encode the name so that we handle '?' in file names correctly.

        NSURL *fileURL = [NSURL fileURLWithPath:filePath];

        NSURL *absoluteFileURL = [NSURL URLWithString:[fileURL relativeString]  relativeToURL:currentTestURL];

        [filePaths addObject:[absoluteFileURL path]];

    }

    [pboard setPropertyList:filePaths forType:NSFilenamesPboardType];

    assert([pboard propertyListForType:NSFilenamesPboardType]); // setPropertyList will silently fail on error, assert that it didn't fail

    // Provide a source, otherwise [DumpRenderTreeDraggingInfo draggingSourceOperationMask] defaults to NSDragOperationNone

    DumpRenderTreeFileDraggingSource *source = [[[DumpRenderTreeFileDraggingSource alloc] init] autorelease];

    draggingInfo = [[DumpRenderTreeDraggingInfo alloc] initWithImage:nil offset:NSZeroSize pasteboard:pboard source:source];

    [[mainFrame webView] draggingEntered:draggingInfo];

    dragMode = NO; // dragMode saves events and then replays them later.  We don't need/want that.

    leftMouseButtonDown = YES; // Make the rest of eventSender think a drag is in progress

}

- (void)updateClickCountForButton:(int)buttonNumber

{

    if (([self currentEventTime] - lastClick >= 1) ||

        !NSEqualPoints(lastMousePosition, lastClickPosition) ||

        lastClickButton != buttonNumber) {

        clickCount = 1;

        lastClickButton = buttonNumber;

    } else

        clickCount++;

}

static int buildModifierFlags(const WebScriptObject* modifiers)

{

    int flags = 0;

    if (![modifiers isKindOfClass:[WebScriptObject class]])

        return flags;

    for (unsigned i = 0; [[modifiers webScriptValueAtIndex:i] isKindOfClass:[NSString class]]; i++) {

        NSString* modifierName = (NSString*)[modifiers webScriptValueAtIndex:i];

        if ([modifierName isEqual:@"ctrlKey"])

            flags |= NSControlKeyMask;

        else if ([modifierName isEqual:@"shiftKey"] || [modifierName isEqual:@"rangeSelectionKey"])

            flags |= NSShiftKeyMask;

        else if ([modifierName isEqual:@"altKey"])

            flags |= NSAlternateKeyMask;

        else if ([modifierName isEqual:@"metaKey"] || [modifierName isEqual:@"addSelectionKey"])

            flags |= NSCommandKeyMask;

    }

    return flags;

}

- (void)mouseDown:(int)buttonNumber withModifiers:(WebScriptObject*)modifiers

{

    [[[mainFrame frameView] documentView] layout];

    [self updateClickCountForButton:buttonNumber];

    NSEventType eventType = eventTypeForMouseButtonAndAction(buttonNumber, MouseDown);

    NSEvent *event = [NSEvent mouseEventWithType:eventType

                                        location:lastMousePosition 

                                   modifierFlags:buildModifierFlags(modifiers)

                                       timestamp:[self currentEventTime]

                                    windowNumber:[[[mainFrame webView] window] windowNumber] 

                                         context:[NSGraphicsContext currentContext] 

                                     eventNumber:++eventNumber 

                                      clickCount:clickCount 

                                        pressure:0.0];

    NSView *subView = [[mainFrame webView] hitTest:[event locationInWindow]];

    if (subView) {

        [subView mouseDown:event];

        if (buttonNumber == LeftMouseButton)

            leftMouseButtonDown = YES;

    }

}

- (void)mouseDown:(int)buttonNumber

{

    [self mouseDown:buttonNumber withModifiers:nil];

}

- (void)textZoomIn

{

    [[mainFrame webView] makeTextLarger:self];

}

- (void)textZoomOut

{

    [[mainFrame webView] makeTextSmaller:self];

}

- (void)zoomPageIn

{

    [[mainFrame webView] zoomPageIn:self];

}

- (void)zoomPageOut

{

    [[mainFrame webView] zoomPageOut:self];

}

- (void)mouseUp:(int)buttonNumber withModifiers:(WebScriptObject*)modifiers

{

    if (dragMode && !replayingSavedEvents) {

        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[EventSendingController instanceMethodSignatureForSelector:@selector(mouseUp:withModifiers:)]];

        [invocation setTarget:self];

        [invocation setSelector:@selector(mouseUp:withModifiers:)];

        [invocation setArgument:&buttonNumber atIndex:2];

        [invocation setArgument:&modifiers atIndex:3];

        [EventSendingController saveEvent:invocation];

        [EventSendingController replaySavedEvents];

        return;

    }

    [[[mainFrame frameView] documentView] layout];

    NSEventType eventType = eventTypeForMouseButtonAndAction(buttonNumber, MouseUp);

    NSEvent *event = [NSEvent mouseEventWithType:eventType

                                        location:lastMousePosition 

                                   modifierFlags:buildModifierFlags(modifiers)

                                       timestamp:[self currentEventTime]

                                    windowNumber:[[[mainFrame webView] window] windowNumber] 

                                         context:[NSGraphicsContext currentContext] 

                                     eventNumber:++eventNumber 

                                      clickCount:clickCount 

                                        pressure:0.0];

    NSView *targetView = [[mainFrame webView] hitTest:[event locationInWindow]];

    // FIXME: Silly hack to teach DRT to respect capturing mouse events outside the WebView.

    // The right solution is just to use NSApplication's built-in event sending methods, 

    // instead of rolling our own algorithm for selecting an event target.

    targetView = targetView ? targetView : [[mainFrame frameView] documentView];

    assert(targetView);

    [targetView mouseUp:event];

    if (buttonNumber == LeftMouseButton)

        leftMouseButtonDown = NO;

    lastClick = [event timestamp];

    lastClickPosition = lastMousePosition;

    if (draggingInfo) {

        WebView *webView = [mainFrame webView];

        NSDragOperation dragOperation = [webView draggingUpdated:draggingInfo];

        if (dragOperation != NSDragOperationNone)

            [webView performDragOperation:draggingInfo];

        else

            [webView draggingExited:draggingInfo];

        // Per NSDragging.h: draggingSources may not implement draggedImage:endedAt:operation:

        if ([[draggingInfo draggingSource] respondsToSelector:@selector(draggedImage:endedAt:operation:)])

            [[draggingInfo draggingSource] draggedImage:[draggingInfo draggedImage] endedAt:lastMousePosition operation:dragOperation];

        [draggingInfo release];

        draggingInfo = nil;

    }

}

- (void)mouseUp:(int)buttonNumber

{

    [self mouseUp:buttonNumber withModifiers:nil];

}

- (void)mouseMoveToX:(int)x Y:(int)y

{

    if (dragMode && leftMouseButtonDown && !replayingSavedEvents) {

        NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:[EventSendingController instanceMethodSignatureForSelector:@selector(mouseMoveToX:Y:)]];

        [invocation setTarget:self];

        [invocation setSelector:@selector(mouseMoveToX:Y:)];

        [invocation setArgument:&x atIndex:2];

        [invocation setArgument:&y atIndex:3];

        [EventSendingController saveEvent:invocation];

        return;

    }

    NSView *view = [mainFrame webView];

    lastMousePosition = [view convertPoint:NSMakePoint(x, [view frame].size.height - y) toView:nil];

    NSEvent *event = [NSEvent mouseEventWithType:(leftMouseButtonDown ? NSLeftMouseDragged : NSMouseMoved)

                                        location:lastMousePosition 

                                   modifierFlags:0 

                                       timestamp:[self currentEventTime]

                                    windowNumber:[[view window] windowNumber] 

                                         context:[NSGraphicsContext currentContext] 

                                     eventNumber:++eventNumber 

                                      clickCount:(leftMouseButtonDown ? clickCount : 0) 

                                        pressure:0.0];

    NSView *subView = [[mainFrame webView] hitTest:[event locationInWindow]];

    if (subView) {

        if (leftMouseButtonDown) {

            [subView mouseDragged:event];

            if (draggingInfo) {

                // Per NSDragging.h: draggingSources may not implement draggedImage:movedTo:

                if ([[draggingInfo draggingSource] respondsToSelector:@selector(draggedImage:movedTo:)])

                    [[draggingInfo draggingSource] draggedImage:[draggingInfo draggedImage] movedTo:lastMousePosition];

                [[mainFrame webView] draggingUpdated:draggingInfo];

            }

        } else

            [subView mouseMoved:event];

    }

}

- (void)mouseScrollByX:(int)x andY:(int)y continuously:(BOOL)c

{

    // CGEventCreateScrollWheelEvent() was introduced in 10.5

#if !defined(BUILDING_ON_TIGER)

    CGScrollEventUnit unit = c?kCGScrollEventUnitPixel:kCGScrollEventUnitLine;

    CGEventRef cgScrollEvent = CGEventCreateScrollWheelEvent(NULL, unit, 2, y, x);

    // CGEvent locations are in global display coordinates.

    CGPoint lastGlobalMousePosition = {

        lastMousePosition.x,

        [[NSScreen mainScreen] frame].size.height - lastMousePosition.y

    };

    CGEventSetLocation(cgScrollEvent, lastGlobalMousePosition);

    NSEvent *scrollEvent = [NSEvent eventWithCGEvent:cgScrollEvent];

    CFRelease(cgScrollEvent);

    NSView *subView = [[mainFrame webView] hitTest:[scrollEvent locationInWindow]];

    if (subView)

        [subView scrollWheel:scrollEvent];

#endif

}

- (void)continuousMouseScrollByX:(int)x andY:(int)y

{

    [self mouseScrollByX:x andY:y continuously:YES];

}

- (void)mouseScrollByX:(int)x andY:(int)y

{

    [self mouseScrollByX:x andY:y continuously:NO];

}

- (NSArray *)contextClick

{

    [[[mainFrame frameView] documentView] layout];

    [self updateClickCountForButton:RightMouseButton];

    NSEvent *event = [NSEvent mouseEventWithType:NSRightMouseDown

                                        location:lastMousePosition 

                                   modifierFlags:0 

                                       timestamp:[self currentEventTime]

                                    windowNumber:[[[mainFrame webView] window] windowNumber] 

                                         context:[NSGraphicsContext currentContext] 

                                     eventNumber:++eventNumber 

                                      clickCount:clickCount 

                                        pressure:0.0];

    NSView *subView = [[mainFrame webView] hitTest:[event locationInWindow]];

    NSMutableArray *menuItemStrings = [NSMutableArray array];

    if (subView) {

        NSMenu* menu = [subView menuForEvent:event];

        for (int i = 0; i < [menu numberOfItems]; ++i) {

            NSMenuItem* menuItem = [menu itemAtIndex:i];

            if (!strcmp("Inspect Element", [[menuItem title] UTF8String]))

                continue;

            if ([menuItem isSeparatorItem])

                [menuItemStrings addObject:@"<separator>"];

            else

                [menuItemStrings addObject:[menuItem title]];

        }

    }