Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebKitLegacy / mac / Plugins / WebNetscapePluginStream.h
1 /*
2  * Copyright (C) 2005 Apple 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 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 <WebKitLegacy/npfunctions.h>
35 #import <wtf/Ref.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
43 namespace WebCore {
44     class FrameLoader;
45     class NetscapePlugInStreamLoader;
46 }
47
48 @class WebNetscapePluginView;
49 @class NSURLResponse;
50
51 class WebNetscapePluginStream : public RefCounted<WebNetscapePluginStream>
52                               , private WebCore::NetscapePlugInStreamLoaderClient
53 {
54 public:
55     static Ref<WebNetscapePluginStream> create(NSURLRequest *request, NPP plugin, bool sendNotification, void* notifyData)
56     {
57         return adoptRef(*new WebNetscapePluginStream(request, plugin, sendNotification, notifyData));
58     }
59     static Ref<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 URL& requestURL) { m_requestURL = requestURL; }
76
77     void start();
78     void stop();
79     
80     void startStreamWithResponse(NSURLResponse *response);
81     
82     void destroyStreamWithError(NSError *);
83
84     // FIXME: Can these be made private?
85     void didReceiveData(WebCore::NetscapePlugInStreamLoader*, const char* bytes, int length) override;
86     void didFinishLoading(WebCore::NetscapePlugInStreamLoader*) override;
87
88 private:
89     void destroyStream();
90     void cancelLoadWithError(NSError *);
91     void destroyStreamWithReason(NPReason);
92     void deliverDataToFile(NSData *data);
93     void deliverData();
94
95     void startStream(NSURL *, long long expectedContentLength, NSDate *lastModifiedDate, const WTF::String& mimeType, NSData *headers);
96     
97     NSError *pluginCancelledConnectionError() const;
98
99     // NetscapePlugInStreamLoaderClient methods.
100     void willSendRequest(WebCore::NetscapePlugInStreamLoader*, WebCore::ResourceRequest&&, const WebCore::ResourceResponse& redirectResponse, CompletionHandler<void(WebCore::ResourceRequest&&)>&&) override;
101     void didReceiveResponse(WebCore::NetscapePlugInStreamLoader*, const WebCore::ResourceResponse&) override;
102     void didFail(WebCore::NetscapePlugInStreamLoader*, const WebCore::ResourceError&) override;
103     bool wantsAllStreams() const override;
104
105     RetainPtr<NSMutableData> m_deliveryData;
106     URL m_requestURL;
107     RetainPtr<NSURL> m_responseURL;
108     CString m_mimeType;
109
110     NPP m_plugin;
111     uint16_t m_transferMode;
112     int32_t m_offset;
113     NPStream m_stream;
114     RetainPtr<NSString> m_path;
115     int m_fileDescriptor;
116     BOOL m_sendNotification;
117     void *m_notifyData;
118     char *m_headers;
119     RetainPtr<WebNetscapePluginView> m_pluginView;
120     NPReason m_reason;
121     bool m_isTerminated;
122     bool m_newStreamSuccessful;
123     
124     WebCore::FrameLoader* m_frameLoader;
125     RefPtr<WebCore::NetscapePlugInStreamLoader> m_loader;
126     RetainPtr<NSMutableURLRequest> m_request;
127     NPPluginFuncs *m_pluginFuncs;
128
129     WebCore::Timer m_deliverDataTimer;
130     
131     WebNetscapePluginStream(WebCore::FrameLoader*);
132     WebNetscapePluginStream(NSURLRequest *, NPP, bool sendNotification, void* notifyData);
133 };
134
135 #endif