/*

 * Copyright (C) 2010 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.

 *

 * THIS SOFTWARE IS PROVIDED BY APPLE INC. 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 INC. 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.

 */

#ifndef NetscapePluginStream_h

#define NetscapePluginStream_h

#include "RunLoop.h"

#include <WebCore/FileSystem.h>

#include <WebCore/npapi.h>

#include <wtf/PassRefPtr.h>

#include <wtf/RefCounted.h>

#include <wtf/RefPtr.h>

#include <wtf/text/CString.h>

namespace WebCore {

    class KURL;

    class String;

}

namespace WebKit {

class NetscapePlugin;

class NetscapePluginStream : public RefCounted<NetscapePluginStream> {

public:

    static PassRefPtr<NetscapePluginStream> create(PassRefPtr<NetscapePlugin> plugin, uint64_t streamID, bool sendNotification, void* notificationData)

    {

        return adoptRef(new NetscapePluginStream(plugin, streamID, sendNotification, notificationData));

    }

    ~NetscapePluginStream();

    uint64_t streamID() const { return m_streamID; }

    const NPStream* npStream() const { return &m_npStream; }

    void didReceiveResponse(const WebCore::KURL& responseURL, uint32_t streamLength,

                            uint32_t lastModifiedTime, const WebCore::String& mimeType, const WebCore::String& headers);

    void didReceiveData(const char* bytes, int length);

    void didFinishLoading();

    void didFail(bool wasCancelled);

    void sendJavaScriptStream(const WebCore::String& requestURLString, const WebCore::String& result);

    void stop(NPReason);

    NPError destroy(NPReason);

private:

    NetscapePluginStream(PassRefPtr<NetscapePlugin>, uint64_t streamID, bool sendNotification, void* notificationData);

    bool start(const WebCore::String& responseURLString, uint32_t streamLength, 

               uint32_t lastModifiedTime, const WebCore::String& mimeType, const WebCore::String& headers);

    void cancel();

    void notifyAndDestroyStream(NPReason);

    void deliverData(const char* bytes, int length);

    void deliverDataToPlugin();

    void deliverDataToFile(const char* bytes, int length);

    RefPtr<NetscapePlugin> m_plugin;

    uint64_t m_streamID;

    bool m_sendNotification;

    void* m_notificationData;

    NPStream m_npStream;

    uint16_t m_transferMode;

    int32_t m_offset;

    CString m_filePath;

    WebCore::PlatformFileHandle m_fileHandle;

    // Whether NPP_NewStream has successfully been called.

    bool m_isStarted;

#if !ASSERT_DISABLED

    bool m_urlNotifyHasBeenCalled;

#endif

    CString m_responseURL;

    CString m_mimeType;

    CString m_headers;

    RunLoop::Timer<NetscapePluginStream> m_deliveryDataTimer;

    OwnPtr< Vector<char> > m_deliveryData;

    bool m_stopStreamWhenDoneDelivering;

};

} // namespace WebKit

#endif // NetscapePluginStream_h