1/*
2 * Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#if ENABLE(NETSCAPE_PLUGIN_API)
30#import <Foundation/Foundation.h>
31
32#import <WebCore/Timer.h>
33#import <WebCore/NetscapePlugInStreamLoader.h>
34#import <WebKit/npfunctions.h>
35#import <wtf/PassRefPtr.h>
36#import <wtf/RefCounted.h>
37#import <wtf/RefPtr.h>
38#import <wtf/RetainPtr.h>
39#import <wtf/text/CString.h>
40
41#import "WebNetscapePluginView.h"
42
43namespace WebCore {
44    class FrameLoader;
45    class NetscapePlugInStreamLoader;
46}
47
48@class WebNetscapePluginView;
49@class NSURLResponse;
50
51class WebNetscapePluginStream : public RefCounted<WebNetscapePluginStream>
52                              , private WebCore::NetscapePlugInStreamLoaderClient
53{
54public:
55    static PassRefPtr<WebNetscapePluginStream> create(NSURLRequest *request, NPP plugin, bool sendNotification, void* notifyData)
56    {
57        return adoptRef(new WebNetscapePluginStream(request, plugin, sendNotification, notifyData));
58    }
59    static PassRefPtr<WebNetscapePluginStream> create(WebCore::FrameLoader* frameLoader)
60    {
61        return adoptRef(new WebNetscapePluginStream(frameLoader));
62    }
63    virtual ~WebNetscapePluginStream();
64
65    NPP plugin() const { return m_plugin; }
66    void setPlugin(NPP);
67
68    static NPP ownerForStream(NPStream *);
69
70    static NPReason reasonForError(NSError *);
71    NSError *errorForReason(NPReason) const;
72
73    void cancelLoadAndDestroyStreamWithError(NSError *);
74
75    void setRequestURL(const WebCore::KURL& requestURL) { m_requestURL = requestURL; }
76
77    void start();
78    void stop();
79
80    void startStreamWithResponse(NSURLResponse *response);
81
82    void didReceiveData(WebCore::NetscapePlugInStreamLoader*, const char* bytes, int length);
83    void destroyStreamWithError(NSError *);
84    void didFinishLoading(WebCore::NetscapePlugInStreamLoader*);
85
86private:
87    void destroyStream();
88    void cancelLoadWithError(NSError *);
89    void destroyStreamWithReason(NPReason);
90    void deliverDataToFile(NSData *data);
91    void deliverData();
92
93    void startStream(NSURL *, long long expectedContentLength, NSDate *lastModifiedDate, const WTF::String& mimeType, NSData *headers);
94
95    NSError *pluginCancelledConnectionError() const;
96
97    // NetscapePlugInStreamLoaderClient methods.
98    void didReceiveResponse(WebCore::NetscapePlugInStreamLoader*, const WebCore::ResourceResponse&);
99    void didFail(WebCore::NetscapePlugInStreamLoader*, const WebCore::ResourceError&);
100    bool wantsAllStreams() const;
101
102    RetainPtr<NSMutableData> m_deliveryData;
103    WebCore::KURL m_requestURL;
104    RetainPtr<NSURL> m_responseURL;
105    CString m_mimeType;
106
107    NPP m_plugin;
108    uint16_t m_transferMode;
109    int32_t m_offset;
110    NPStream m_stream;
111    RetainPtr<NSString> m_path;
112    int m_fileDescriptor;
113    BOOL m_sendNotification;
114    void *m_notifyData;
115    char *m_headers;
116    RetainPtr<WebNetscapePluginView> m_pluginView;
117    NPReason m_reason;
118    bool m_isTerminated;
119    bool m_newStreamSuccessful;
120
121    WebCore::FrameLoader* m_frameLoader;
122    RefPtr<WebCore::NetscapePlugInStreamLoader> m_loader;
123    RetainPtr<NSMutableURLRequest> m_request;
124    NPPluginFuncs *m_pluginFuncs;
125
126    void deliverDataTimerFired(WebCore::Timer<WebNetscapePluginStream>* timer);
127    WebCore::Timer<WebNetscapePluginStream> m_deliverDataTimer;
128
129    WebNetscapePluginStream(WebCore::FrameLoader*);
130    WebNetscapePluginStream(NSURLRequest *, NPP, bool sendNotification, void* notifyData);
131};
132
133#endif
134