Implement NPAPI redirect handling
[WebKit-https.git] / Source / WebKit / win / Plugins / PluginStream.h
1 /*
2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Collabora, Ltd. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef PluginStream_h
28 #define PluginStream_h
29
30 #include "FileSystem.h"
31 #include "URL.h"
32 #include "NetscapePlugInStreamLoader.h"
33 #include "PluginQuirkSet.h"
34 #include "ResourceRequest.h"
35 #include "ResourceResponse.h"
36 #include "Timer.h"
37 #include "npruntime_internal.h"
38 #include <wtf/HashMap.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/Vector.h>
41 #include <wtf/text/CString.h>
42 #include <wtf/text/StringHash.h>
43 #include <wtf/text/WTFString.h>
44
45 namespace WebCore {
46     class Frame;
47     class PluginStream;
48
49     enum PluginStreamState { StreamBeforeStarted, StreamStarted, StreamStopped };
50
51     class PluginStreamClient {
52     public:
53         virtual ~PluginStreamClient() {}
54         virtual void streamDidFinishLoading(PluginStream*) {}
55     };
56
57     class PluginStream : public RefCounted<PluginStream>, private NetscapePlugInStreamLoaderClient {
58     public:
59         static PassRefPtr<PluginStream> create(PluginStreamClient* client, Frame* frame, const ResourceRequest& request, bool sendNotification, void* notifyData, const NPPluginFuncs* functions, NPP instance, const PluginQuirkSet& quirks)
60         {
61             return adoptRef(new PluginStream(client, frame, request, sendNotification, notifyData, functions, instance, quirks));
62         }
63         virtual ~PluginStream();
64         
65         void start();
66         void stop();
67
68         void startStream();
69
70         void setLoadManually(bool loadManually) { m_loadManually = loadManually; }
71
72         void sendJavaScriptStream(const URL& requestURL, const WTF::CString& resultString);
73         void cancelAndDestroyStream(NPReason);
74
75         static NPP ownerForStream(NPStream*);
76
77     private:
78         PluginStream(PluginStreamClient*, Frame*, const ResourceRequest&, bool sendNotification, void* notifyData, const NPPluginFuncs*, NPP instance, const PluginQuirkSet&);
79
80         void deliverData();
81         void destroyStream(NPReason);
82         void destroyStream();
83
84         // NetscapePlugInStreamLoaderClient
85         void willSendRequest(NetscapePlugInStreamLoader*, ResourceRequest&&, const ResourceResponse& redirectResponse, std::function<void (ResourceRequest&&)>&&) override;
86         void didReceiveResponse(NetscapePlugInStreamLoader*, const ResourceResponse&) override;
87         void didReceiveData(NetscapePlugInStreamLoader*, const char*, int) override;
88         void didFail(NetscapePlugInStreamLoader*, const ResourceError&) override;
89         void didFinishLoading(NetscapePlugInStreamLoader*) override;
90         bool wantsAllStreams() const override;
91
92         ResourceRequest m_resourceRequest;
93         ResourceResponse m_resourceResponse;
94
95         PluginStreamClient* m_client;
96         Frame* m_frame;
97         RefPtr<NetscapePlugInStreamLoader> m_loader;
98         void* m_notifyData;
99         bool m_sendNotification;
100         PluginStreamState m_streamState;
101         bool m_loadManually;
102
103         Timer m_delayDeliveryTimer;
104         void delayDeliveryTimerFired();
105
106         std::unique_ptr<Vector<char>> m_deliveryData;
107
108         PlatformFileHandle m_tempFileHandle;
109
110         const NPPluginFuncs* m_pluginFuncs;
111         NPP m_instance;
112         uint16_t m_transferMode;
113         int32_t m_offset;
114         CString m_headers;
115         String m_path;
116         NPReason m_reason;
117         NPStream m_stream;
118         PluginQuirkSet m_quirks;
119     };
120
121 } // namespace WebCore
122
123 #endif