Home | History | Annotate | Download | only in Plugins 
      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 
     40 #import "WebNetscapePluginView.h"
     41 
     42 namespace WebCore {
     43     class FrameLoader;
     44     class NetscapePlugInStreamLoader;
     45 }
     46 
     47 @class WebNetscapePluginView;
     48 @class NSURLResponse;
     49 
     50 class WebNetscapePluginStream : public RefCounted<WebNetscapePluginStream>
     51                               , private WebCore::NetscapePlugInStreamLoaderClient
     52 {
     53 public:
     54     static PassRefPtr<WebNetscapePluginStream> create(NSURLRequest *request, NPP plugin, bool sendNotification, void* notifyData)
     55     {
     56         return adoptRef(new WebNetscapePluginStream(request, plugin, sendNotification, notifyData));
     57     }
     58     static PassRefPtr<WebNetscapePluginStream> create(WebCore::FrameLoader* frameLoader)
     59     {
     60         return adoptRef(new WebNetscapePluginStream(frameLoader));
     61     }
     62     virtual ~WebNetscapePluginStream();
     63 
     64     NPP plugin() const { return m_plugin; }
     65     void setPlugin(NPP);
     66 
     67     static NPP ownerForStream(NPStream *);
     68 
     69     static NPReason reasonForError(NSError *);
     70     NSError *errorForReason(NPReason) const;
     71 
     72     void cancelLoadAndDestroyStreamWithError(NSError *);
     73 
     74     void setRequestURL(NSURL *requestURL) { m_requestURL = requestURL; }
     75 
     76     void start();
     77     void stop();
     78 
     79     void startStreamWithResponse(NSURLResponse *response);
     80 
     81     void didReceiveData(WebCore::NetscapePlugInStreamLoader*, const char* bytes, int length);
     82     void destroyStreamWithError(NSError *);
     83     void didFinishLoading(WebCore::NetscapePlugInStreamLoader*);
     84 
     85 private:
     86     void destroyStream();
     87     void cancelLoadWithError(NSError *);
     88     void destroyStreamWithReason(NPReason);
     89     void deliverDataToFile(NSData *data);
     90     void deliverData();
     91 
     92     void startStream(NSURL *, long long expectedContentLength, NSDate *lastModifiedDate, NSString *mimeType, NSData *headers);
     93 
     94     NSError *pluginCancelledConnectionError() const;
     95 
     96     // NetscapePlugInStreamLoaderClient methods.
     97     void didReceiveResponse(WebCore::NetscapePlugInStreamLoader*, const WebCore::ResourceResponse&);
     98     void didFail(WebCore::NetscapePlugInStreamLoader*, const WebCore::ResourceError&);
     99     bool wantsAllStreams() const;
    100 
    101     RetainPtr<NSMutableData> m_deliveryData;
    102     RetainPtr<NSURL> m_requestURL;
    103     RetainPtr<NSURL> m_responseURL;
    104     RetainPtr<NSString> m_mimeType;
    105 
    106     NPP m_plugin;
    107     uint16 m_transferMode;
    108     int32 m_offset;
    109     NPStream m_stream;
    110     RetainPtr<NSString> m_path;
    111     int m_fileDescriptor;
    112     BOOL m_sendNotification;
    113     void *m_notifyData;
    114     char *m_headers;
    115     RetainPtr<WebNetscapePluginView> m_pluginView;
    116     NPReason m_reason;
    117     bool m_isTerminated;
    118     bool m_newStreamSuccessful;
    119 
    120     WebCore::FrameLoader* m_frameLoader;
    121     RefPtr<WebCore::NetscapePlugInStreamLoader> m_loader;
    122     RetainPtr<NSMutableURLRequest> m_request;
    123     NPPluginFuncs *m_pluginFuncs;
    124 
    125     void deliverDataTimerFired(WebCore::Timer<WebNetscapePluginStream>* timer);
    126     WebCore::Timer<WebNetscapePluginStream> m_deliverDataTimer;
    127 
    128     WebNetscapePluginStream(WebCore::FrameLoader*);
    129     WebNetscapePluginStream(NSURLRequest *, NPP, bool sendNotification, void* notifyData);
    130 };
    131 
    132 #endif
    133