Source/WebKit2/UIProcess/Downloads/DownloadProxy.h

   1 /*
   2  * Copyright (C) 2010 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  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef DownloadProxy_h
  27 #define DownloadProxy_h
  28
  29 #include "APIObject.h"
  30 #include "Connection.h"
  31 #include "SandboxExtension.h"
  32 #include <WebCore/ResourceRequest.h>
  33 #include <wtf/Forward.h>
  34 #include <wtf/PassRefPtr.h>
  35
  36 namespace API {
  37 class Data;
  38 }
  39
  40 namespace WebCore {
  41     class AuthenticationChallenge;
  42     class ResourceError;
  43     class ResourceResponse;
  44 }
  45
  46 namespace WebKit {
  47
  48 class DownloadProxyMap;
  49 class WebPageProxy;
  50 class WebProcessPool;
  51
  52 class DownloadProxy : public API::ObjectImpl<API::Object::Type::Download>, public IPC::MessageReceiver {
  53 public:
  54     static PassRefPtr<DownloadProxy> create(DownloadProxyMap&, WebProcessPool&, const WebCore::ResourceRequest&);
  55     ~DownloadProxy();
  56
  57     uint64_t downloadID() const { return m_downloadID; }
  58     const WebCore::ResourceRequest& request() const { return m_request; }
  59     API::Data* resumeData() const { return m_resumeData.get(); }
  60
  61     void cancel();
  62
  63     void invalidate();
  64     void processDidClose();
  65
  66     void didReceiveDownloadProxyMessage(IPC::Connection&, IPC::MessageDecoder&);
  67     void didReceiveSyncDownloadProxyMessage(IPC::Connection&, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&);
  68
  69 private:
  70     explicit DownloadProxy(DownloadProxyMap&, WebProcessPool&, const WebCore::ResourceRequest&);
  71
  72     // IPC::MessageReceiver
  73     virtual void didReceiveMessage(IPC::Connection&, IPC::MessageDecoder&) override;
  74     virtual void didReceiveSyncMessage(IPC::Connection&, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&) override;
  75
  76     // Message handlers.
  77     void didStart(const WebCore::ResourceRequest&);
  78     void didReceiveAuthenticationChallenge(const WebCore::AuthenticationChallenge&, uint64_t challengeID);
  79     void didReceiveResponse(const WebCore::ResourceResponse&);
  80     void didReceiveData(uint64_t length);
  81     void shouldDecodeSourceDataOfMIMEType(const String& mimeType, bool& result);
  82     void decideDestinationWithSuggestedFilename(const String& filename, String& destination, bool& allowOverwrite, SandboxExtension::Handle& sandboxExtensionHandle);
  83     void didCreateDestination(const String& path);
  84     void didFinish();
  85     void didFail(const WebCore::ResourceError&, const IPC::DataReference& resumeData);
  86     void didCancel(const IPC::DataReference& resumeData);
  87
  88     DownloadProxyMap& m_downloadProxyMap;
  89     RefPtr<WebProcessPool> m_processPool;
  90     uint64_t m_downloadID;
  91
  92     RefPtr<API::Data> m_resumeData;
  93     WebCore::ResourceRequest m_request;
  94 };
  95
  96 } // namespace WebKit
  97
  98 #endif // DownloadProxy_h