/*

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

 *

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

 */

#if ENABLE(NETSCAPE_PLUGIN_API)

#import "WebBaseNetscapePluginView.h"

#import "WebFrameInternal.h"

#import "WebKitLogging.h"

#import "WebKitNSStringExtras.h"

#import "WebKitSystemInterface.h"

#import "WebPluginContainerCheck.h"

#import "WebNetscapeContainerCheckContextInfo.h"

#import "WebNSURLExtras.h"

#import "WebNSURLRequestExtras.h"

#import "WebView.h"

#import "WebViewInternal.h"

#import <WebCore/AuthenticationMac.h>

#import <WebCore/BitmapImage.h>

#import <WebCore/Credential.h>

#import <WebCore/CredentialStorage.h>

#import <WebCore/Document.h>

#import <WebCore/Element.h>

#import <WebCore/Frame.h>

#import <WebCore/FrameLoader.h>

#import <WebCore/HTMLPlugInElement.h>

#import <WebCore/HaltablePlugin.h>

#import <WebCore/Page.h>

#import <WebCore/ProtectionSpace.h>

#import <WebCore/RenderView.h>

#import <WebCore/RenderWidget.h>

#import <WebCore/WebCoreObjCExtras.h>

#import <WebKit/DOMPrivate.h>

#import <runtime/InitializeThreading.h>

#import <wtf/Assertions.h>

#import <wtf/Threading.h>

#import <wtf/text/CString.h>

#define LoginWindowDidSwitchFromUserNotification    @"WebLoginWindowDidSwitchFromUserNotification"

#define LoginWindowDidSwitchToUserNotification      @"WebLoginWindowDidSwitchToUserNotification"

static const NSTimeInterval ClearSubstituteImageDelay = 0.5;

using namespace WebCore;

class WebHaltablePlugin : public HaltablePlugin {

public:

    WebHaltablePlugin(WebBaseNetscapePluginView* view)

        : m_view(view)

    {

    }

private:

    virtual void halt();

    virtual void restart();

    virtual Node* node() const;

    virtual bool isWindowed() const;

    virtual String pluginName() const;

    WebBaseNetscapePluginView* m_view;

};

void WebHaltablePlugin::halt()

{

    [m_view halt];

}

void WebHaltablePlugin::restart()

{ 

    [m_view resumeFromHalt];

}

Node* WebHaltablePlugin::node() const

{

    return [m_view element];

}

bool WebHaltablePlugin::isWindowed() const

{

    return false;

}

String WebHaltablePlugin::pluginName() const

{

    return [[m_view pluginPackage] pluginInfo].name;

}

@implementation WebBaseNetscapePluginView

+ (void)initialize

{

    JSC::initializeThreading();

    WTF::initializeMainThreadToProcessMainThread();

#ifndef BUILDING_ON_TIGER

    WebCoreObjCFinalizeOnMainThread(self);

#endif

    WKSendUserChangeNotifications();

}

- (id)initWithFrame:(NSRect)frame

      pluginPackage:(WebNetscapePluginPackage *)pluginPackage

                URL:(NSURL *)URL

            baseURL:(NSURL *)baseURL

           MIMEType:(NSString *)MIME

      attributeKeys:(NSArray *)keys

    attributeValues:(NSArray *)values

       loadManually:(BOOL)loadManually

            element:(PassRefPtr<WebCore::HTMLPlugInElement>)element

{

    self = [super initWithFrame:frame];

    if (!self)

        return nil;

    _pluginPackage = pluginPackage;

    _element = element;

    _sourceURL.adoptNS([URL copy]);

    _baseURL.adoptNS([baseURL copy]);

    _MIMEType.adoptNS([MIME copy]);

#if !defined(BUILDING_ON_TIGER) && !defined(BUILDING_ON_LEOPARD)

    // Enable "kiosk mode" when instantiating the QT plug-in inside of Dashboard. See <rdar://problem/6878105>

    if ([[[NSBundle mainBundle] bundleIdentifier] isEqualToString:@"com.apple.dashboard.client"] &&

        [_pluginPackage.get() bundleIdentifier] == "com.apple.QuickTime Plugin.plugin") {

        RetainPtr<NSMutableArray> mutableKeys(AdoptNS, [keys mutableCopy]);

        RetainPtr<NSMutableArray> mutableValues(AdoptNS, [values mutableCopy]);

        [mutableKeys.get() addObject:@"kioskmode"];

        [mutableValues.get() addObject:@"true"];

        [self setAttributeKeys:mutableKeys.get() andValues:mutableValues.get()];

    } else

#endif

         [self setAttributeKeys:keys andValues:values];

    if (loadManually)

        _mode = NP_FULL;

    else

        _mode = NP_EMBED;

    _loadManually = loadManually;

    _haltable = new WebHaltablePlugin(self);

    return self;

}

- (void)dealloc

{

    ASSERT(!_isStarted);

    [super dealloc];

}

- (void)finalize

{

    ASSERT_MAIN_THREAD();

    ASSERT(!_isStarted);

    [super finalize];

}

- (WebNetscapePluginPackage *)pluginPackage

{

    return _pluginPackage.get();

}

- (BOOL)isFlipped

{

    return YES;

}

- (NSURL *)URLWithCString:(const char *)URLCString

{

    if (!URLCString)

        return nil;

    CFStringRef string = CFStringCreateWithCString(kCFAllocatorDefault, URLCString, kCFStringEncodingISOLatin1);

    ASSERT(string); // All strings should be representable in ISO Latin 1

    NSString *URLString = [(NSString *)string _web_stringByStrippingReturnCharacters];

    NSURL *URL = [NSURL _web_URLWithDataAsString:URLString relativeToURL:_baseURL.get()];

    CFRelease(string);

    if (!URL)

        return nil;

    return URL;

}

- (NSMutableURLRequest *)requestWithURLCString:(const char *)URLCString

{

    NSURL *URL = [self URLWithCString:URLCString];

    if (!URL)

        return nil;

    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:URL];

    Frame* frame = core([self webFrame]);

    if (!frame)

        return nil;

    [request _web_setHTTPReferrer:frame->loader()->outgoingReferrer()];

    return request;

}

// Methods that subclasses must override

- (void)setAttributeKeys:(NSArray *)keys andValues:(NSArray *)values

{

    ASSERT_NOT_REACHED();

}

- (void)handleMouseMoved:(NSEvent *)event

{

    ASSERT_NOT_REACHED();

}

- (void)handleMouseEntered:(NSEvent *)event

{

    ASSERT_NOT_REACHED();

}

- (void)handleMouseExited:(NSEvent *)event

{

    ASSERT_NOT_REACHED();

}

- (void)focusChanged

{

    ASSERT_NOT_REACHED();

}

- (void)windowFocusChanged:(BOOL)hasFocus

{

    ASSERT_NOT_REACHED();

}

- (BOOL)createPlugin

{

    ASSERT_NOT_REACHED();

    return NO;

}

- (void)loadStream

{

    ASSERT_NOT_REACHED();

}

- (BOOL)shouldStop

{

    ASSERT_NOT_REACHED();

    return YES;

}

- (void)destroyPlugin

{

    ASSERT_NOT_REACHED();

}

- (void)updateAndSetWindow

{

    ASSERT_NOT_REACHED();

}

- (void)sendModifierEventWithKeyCode:(int)keyCode character:(char)character

{

    ASSERT_NOT_REACHED();

}

- (void)privateBrowsingModeDidChange

{

}

- (void)removeTrackingRect

{

    if (_trackingTag) {

        [self removeTrackingRect:_trackingTag];

        _trackingTag = 0;

        // Do the following after setting trackingTag to 0 so we don't re-enter.

        // Balance the retain in resetTrackingRect. Use autorelease in case we hold 

        // the last reference to the window during tear-down, to avoid crashing AppKit. 

        [[self window] autorelease];

    }

}

- (void)resetTrackingRect

{

    [self removeTrackingRect];

    if (_isStarted) {

        // Retain the window so that removeTrackingRect can work after the window is closed.

        [[self window] retain];

        _trackingTag = [self addTrackingRect:[self bounds] owner:self userData:nil assumeInside:NO];

    }

}

- (void)stopTimers

{

    _shouldFireTimers = NO;

}

- (void)startTimers

{

    _shouldFireTimers = YES;

}

- (void)restartTimers

{

    ASSERT([self window]);

    [self stopTimers];

    if (!_isStarted || [[self window] isMiniaturized])

        return;

    [self startTimers];

}

- (NSRect)_windowClipRect

{

    RenderObject* renderer = _element->renderer();

    if (!renderer || !renderer->view())

        return NSZeroRect;

    return toRenderWidget(renderer)->windowClipRect();

}

- (NSRect)visibleRect

{

    // WebCore may impose an additional clip (via CSS overflow or clip properties).  Fetch

    // that clip now.    

    return NSIntersectionRect([self convertRect:[self _windowClipRect] fromView:nil], [super visibleRect]);

}

- (void)visibleRectDidChange

{

    [self renewGState];

}

- (BOOL)acceptsFirstResponder

{

    return YES;

}

- (void)sendActivateEvent:(BOOL)activate

{

    if (!_isStarted)

        return;

    [self windowFocusChanged:activate];

}

- (void)setHasFocus:(BOOL)flag

{

    if (!_isStarted)

        return;

    if (_hasFocus == flag)

        return;

    _hasFocus = flag;

    [self focusChanged];

}

- (void)addWindowObservers

{

    ASSERT([self window]);

    NSWindow *theWindow = [self window];

    NSNotificationCenter *notificationCenter = [NSNotificationCenter defaultCenter];

    [notificationCenter addObserver:self selector:@selector(windowWillClose:) 

                               name:NSWindowWillCloseNotification object:theWindow]; 

    [notificationCenter addObserver:self selector:@selector(windowBecameKey:)

                               name:NSWindowDidBecomeKeyNotification object:theWindow];

    [notificationCenter addObserver:self selector:@selector(windowResignedKey:)

                               name:NSWindowDidResignKeyNotification object:theWindow];

    [notificationCenter addObserver:self selector:@selector(windowDidMiniaturize:)

                               name:NSWindowDidMiniaturizeNotification object:theWindow];

    [notificationCenter addObserver:self selector:@selector(windowDidDeminiaturize:)

                               name:NSWindowDidDeminiaturizeNotification object:theWindow];

    [notificationCenter addObserver:self selector:@selector(loginWindowDidSwitchFromUser:)

                               name:LoginWindowDidSwitchFromUserNotification object:nil];

    [notificationCenter addObserver:self selector:@selector(loginWindowDidSwitchToUser:)

                               name:LoginWindowDidSwitchToUserNotification object:nil];

}

- (void)removeWindowObservers

{

    NSNotificationCenter *notificationCenter = [NSNotificationCenter defaultCenter];

    [notificationCenter removeObserver:self name:NSWindowWillCloseNotification        object:nil]; 

    [notificationCenter removeObserver:self name:NSWindowDidBecomeKeyNotification     object:nil];

    [notificationCenter removeObserver:self name:NSWindowDidResignKeyNotification     object:nil];

    [notificationCenter removeObserver:self name:NSWindowDidMiniaturizeNotification   object:nil];

    [notificationCenter removeObserver:self name:NSWindowDidDeminiaturizeNotification object:nil];

    [notificationCenter removeObserver:self name:LoginWindowDidSwitchFromUserNotification   object:nil];

    [notificationCenter removeObserver:self name:LoginWindowDidSwitchToUserNotification     object:nil];

}

- (void)start

{

    ASSERT([self currentWindow]);

    if (_isStarted)

        return;

    if (_triedAndFailedToCreatePlugin)

        return;

    ASSERT([self webView]);

    if (![[[self webView] preferences] arePlugInsEnabled])

        return;

    Frame* frame = core([self webFrame]);

    if (!frame)

        return;

    Page* page = frame->page();

    if (!page)

        return;

    bool wasDeferring = page->defersLoading();

    if (!wasDeferring)

        page->setDefersLoading(true);

    BOOL result = [self createPlugin];

    if (!wasDeferring)

        page->setDefersLoading(false);

    if (!result) {

        _triedAndFailedToCreatePlugin = YES;

        return;

    }

    _isStarted = YES;

    page->didStartPlugin(_haltable.get());

    [[self webView] addPluginInstanceView:self];

    if ([self currentWindow])

        [self updateAndSetWindow];

    if ([self window]) {

        [self addWindowObservers];

        if ([[self window] isKeyWindow]) {

            [self sendActivateEvent:YES];

        }

        [self restartTimers];

    }

    [self resetTrackingRect];

    [self loadStream];

}

- (void)stop

{

    if (![self shouldStop])

        return;

    [self removeTrackingRect];

    if (!_isStarted)

        return;

    if (Frame* frame = core([self webFrame])) {

        if (Page* page = frame->page())

            page->didStopPlugin(_haltable.get());

    }

    _isStarted = NO;

    [[self webView] removePluginInstanceView:self];

    // Stop the timers

    [self stopTimers];

    // Stop notifications and callbacks.

    [self removeWindowObservers];

    [self destroyPlugin];

}

- (void)halt

{

    ASSERT(!_isHalted);

    ASSERT(_isStarted);

    Element *element = [self element];

#if !defined(BUILDING_ON_TIGER) && !defined(BUILDING_ON_LEOPARD)

    CGImageRef cgImage = CGImageRetain([core([self webFrame])->nodeImage(element) CGImageForProposedRect:nil context:nil hints:nil]);

#else

    RetainPtr<CGImageSourceRef> imageRef(AdoptCF, CGImageSourceCreateWithData((CFDataRef)[core([self webFrame])->nodeImage(element) TIFFRepresentation], 0));

    CGImageRef cgImage = CGImageSourceCreateImageAtIndex(imageRef.get(), 0, 0);

#endif

    ASSERT(cgImage);

    // BitmapImage will release the passed in CGImage on destruction.

    RefPtr<Image> nodeImage = BitmapImage::create(cgImage);

    ASSERT(element->renderer());

    toRenderWidget(element->renderer())->showSubstituteImage(nodeImage);

    [self stop];

    _isHalted = YES;  

    _hasBeenHalted = YES;

}