aboutsummaryrefslogtreecommitdiffstats
path: root/embed/mozilla/MozDownload.h
blob: 411230bdbe5a5bcc23f69241b32a09ec0a4aa4c3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright © 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Conrad Carlen <ccarlen@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK *****
 *
 * $Id$
 */

#ifndef MozDownload_h__
#define MozDownload_h__

#include <nsCOMPtr.h>
#include <nsIInterfaceRequestor.h>
#include <nsITransfer.h>
#include <nsIWebProgressListener.h>

#include "mozilla-embed-persist.h"
#include "downloader-view.h"
#include "ephy-download.h"
#include "ephy-embed-shell.h"

class nsICancelable;
class nsIDOMDocument;
class nsIInputStream;
class nsILocalFile;
class nsIMIMEInfo;
class nsIObserver;
class nsIRequest;
class nsIURI;
class nsIWebBrowserPersist;

/* MozDownload
   Holds information used to display a single download in the UI. This object is 
   created in one of two ways:
   (1) By nsExternalHelperAppHandler when Gecko encounters a  MIME type which
       it doesn't itself handle. In this case, the notifications sent to
       nsIDownload are controlled by nsExternalHelperAppHandler.
   (2) By the embedding app's file saving code when saving a web page or a link
       target. See CHeaderSniffer.cpp. In this case, the notifications sent to
       nsIDownload are controlled by the implementation of nsIWebBrowserPersist.
*/

#define MOZ_DOWNLOAD_CID                \
{ /* d2a2f743-f126-4f1f-1234-d4e50490f112 */         \
    0xd2a2f743,                                      \
    0xf126,                                          \
    0x4f1f,                                          \
    {0x12, 0x34, 0xd4, 0xe5, 0x04, 0x90, 0xf1, 0x12} \
}

#define MOZ_DOWNLOAD_CLASSNAME "Ephy's Download Progress Dialog"

nsresult InitiateMozillaDownload (nsIDOMDocument *domDocument, nsIURI *sourceUri,
                  nsILocalFile* inDestFile, const char *contentType,
                  nsIURI* inOriginalURI, MozillaEmbedPersist *embedPersist,
                  nsIInputStream *postData, nsISupports *aCacheKey,
                  PRInt64 aMaxSize);
nsresult BuildDownloadPath (const char *defaultFileName, nsILocalFile **_retval);

class MozDownload : public nsITransfer,
            public nsIInterfaceRequestor
{
public:
        MozDownload();
    virtual ~MozDownload();
    
    NS_DECL_ISUPPORTS
    NS_DECL_NSIWEBPROGRESSLISTENER
    NS_DECL_NSIWEBPROGRESSLISTENER2
    NS_DECL_NSITRANSFER
    NS_DECL_NSIINTERFACEREQUESTOR

    nsresult GetMIMEInfo (nsIMIMEInfo **aMIMEInfo);
    nsresult GetTargetFile (nsILocalFile **aFile);
    nsresult GetSource(nsIURI * *aSource);
    nsresult GetPercentComplete(PRInt32 *aPercentComplete);

    virtual void Cancel();
    virtual void Pause();
    virtual void Resume();

    nsresult GetState           (EphyDownloadState *aDownloadState);
    nsresult GetCurrentProgress (PRInt64 *aCurrentProgress);
    nsresult GetTotalProgress   (PRInt64 *aTProgress);
    nsresult GetElapsedTime     (PRInt64 *aTProgress);

    nsresult InitForEmbed       (nsIURI *aSource, nsIURI *aTarget,
                     const nsAString &aDisplayName, nsIMIMEInfo *aMIMEInfo,
                     PRTime aStartTime, nsILocalFile *aTempFile,
                     nsICancelable *aCancelable, MozillaEmbedPersist *aEmbedPersist,
                     PRInt64 aMaxSize);

protected:
    nsCOMPtr<nsIURI>        mSource;
    nsCOMPtr<nsIURI>        mDestination;

    nsCOMPtr<nsIMIMEInfo>   mMIMEInfo;
    PRTime                  mStartTime;
    PRTime              mLastUpdate;
    PRInt64             mElapsed;
    PRInt32             mInterval;
    PRInt32                 mPercentComplete;
    PRInt64                 mTotalProgress;
    PRInt64                 mCurrentProgress;
    PRInt64         mMaxSize;
    PRBool          mAddToRecent;

    nsresult                mStatus;

    nsCOMPtr<nsICancelable>     mCancelable;
    nsCOMPtr<nsIRequest>        mRequest;
    EphyDownload                   *mEphyDownload;
    DownloaderView                 *mDownloaderView;
    MozillaEmbedPersist            *mEmbedPersist;
    EphyDownloadState               mDownloadState;
};

#endif // MozDownload_h__