aboutsummaryrefslogtreecommitdiff
path: root/Src/Components/wac_downloadManager/wac_downloadManager_api.h
blob: 99ce9a790551ed2a97551fc6a2f9b9d9609d1da5 (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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
#ifndef NULLSOFT_WAC_DOWNLOAD_MANAGER_API_DOWNLOADMANAGER_H
#define NULLSOFT_WAC_DOWNLOAD_MANAGER_API_DOWNLOADMANAGER_H

#include "bfc/dispatch.h"

typedef void *DownloadToken;

class ifc_downloadManagerCallback;
class api_httpreceiver;

class ifc_downloadManagerCallback : public Dispatchable
{
public:
	void OnFinish( DownloadToken token );
	void OnTick( DownloadToken token );
	void OnError( DownloadToken token, int error );
	void OnCancel( DownloadToken token );
	void OnConnect( DownloadToken token );
	void OnInit( DownloadToken token );
	void OnData( DownloadToken token, void *data, size_t datalen );

	int  GetSource( wchar_t *source, size_t source_cch );
	int  GetTitle( wchar_t *title, size_t title_cch );
	int  GetLocation( wchar_t *location, size_t location_cch );

	DISPATCH_CODES
	{
		IFC_DOWNLOADMANAGERCALLBACK_ONFINISH    =  10,
		IFC_DOWNLOADMANAGERCALLBACK_ONTICK      =  20,
		IFC_DOWNLOADMANAGERCALLBACK_ONERROR     =  30,
		IFC_DOWNLOADMANAGERCALLBACK_ONCANCEL    =  40,
		IFC_DOWNLOADMANAGERCALLBACK_ONCONNECT   =  50,
		IFC_DOWNLOADMANAGERCALLBACK_ONINIT      =  60,
		IFC_DOWNLOADMANAGERCALLBACK_ONDATA      =  70,
		IFC_DOWNLOADMANAGERCALLBACK_GETSOURCE   =  80,
		IFC_DOWNLOADMANAGERCALLBACK_GETTITLE    =  90,
		IFC_DOWNLOADMANAGERCALLBACK_GETLOCATION = 100,
	};
};

inline void ifc_downloadManagerCallback::OnFinish( DownloadToken token )
{
	_voidcall( IFC_DOWNLOADMANAGERCALLBACK_ONFINISH, token );
}

inline void ifc_downloadManagerCallback::OnTick( DownloadToken token )
{
	_voidcall( IFC_DOWNLOADMANAGERCALLBACK_ONTICK, token );
}

inline void ifc_downloadManagerCallback::OnError( DownloadToken token, int error )
{
	_voidcall( IFC_DOWNLOADMANAGERCALLBACK_ONERROR, token, error );
}

inline void ifc_downloadManagerCallback::OnCancel( DownloadToken token )
{
	_voidcall( IFC_DOWNLOADMANAGERCALLBACK_ONCANCEL, token );
}

inline void ifc_downloadManagerCallback::OnConnect( DownloadToken token )
{
	_voidcall( IFC_DOWNLOADMANAGERCALLBACK_ONCONNECT, token );
}

inline void ifc_downloadManagerCallback::OnInit( DownloadToken token )
{
	_voidcall( IFC_DOWNLOADMANAGERCALLBACK_ONINIT, token );
}

inline void ifc_downloadManagerCallback::OnData( DownloadToken token, void *data, size_t datalen )
{
	_voidcall( IFC_DOWNLOADMANAGERCALLBACK_ONDATA, token, data, datalen );
}

inline int ifc_downloadManagerCallback::GetSource( wchar_t *source, size_t source_cch )
{
	return _call( IFC_DOWNLOADMANAGERCALLBACK_GETSOURCE, (int)1, source, source_cch );
}

inline int ifc_downloadManagerCallback::GetTitle( wchar_t *title, size_t title_cch )
{
	return _call( IFC_DOWNLOADMANAGERCALLBACK_GETTITLE, (int)1, title, title_cch );
}

inline int ifc_downloadManagerCallback::GetLocation( wchar_t *location, size_t location_cch )
{
	return _call( IFC_DOWNLOADMANAGERCALLBACK_GETLOCATION, (int)1, location, location_cch );
}


class api_downloadManager : public Dispatchable
{
public:
	DownloadToken     Download( const char *url, ifc_downloadManagerCallback *callback );
	DownloadToken     DownloadEx( const char *url, ifc_downloadManagerCallback *callback, int flags );

	api_httpreceiver *GetReceiver( DownloadToken token );
	const wchar_t    *GetLocation( DownloadToken token );
	void              SetLocation( DownloadToken token, const wchar_t *p_location );


	const char       *GetExtention( DownloadToken token );
	const char       *GetUrl( DownloadToken token );

	int               GetBuffer( DownloadToken token, void **buffer, size_t *bufferLength );
	uint64_t          GetBytesDownloaded( DownloadToken token );

	void              ResumePendingDownload( DownloadToken token );
	void              CancelDownload( DownloadToken token );
	void              RetainDownload( DownloadToken token );
	void              ReleaseDownload( DownloadToken token );

	/* added in 5.58 */
	void              RegisterStatusCallback( ifc_downloadManagerCallback *callback );
	void              UnregisterStatusCallback( ifc_downloadManagerCallback *callback );

	const wchar_t    *GetSource( DownloadToken token );
	const wchar_t    *GetTitle( DownloadToken token );

	bool              IsPending( DownloadToken token );

	DISPATCH_CODES
	{
		API_DOWNLOADMANAGER_DOWNLOAD                 =  10,
		API_DOWNLOADMANAGER_DOWNLOADEX               =  20,
		API_DOWNLOADMANAGER_GETRECEIVER              = 100,
		API_DOWNLOADMANAGER_GETLOCATION              = 110,
		API_DOWNLOADMANAGER_SETLOCATION              = 112,
		API_DOWNLOADMANAGER_GETEXTENTION             = 115,
		API_DOWNLOADMANAGER_GETURL                   = 117,
		API_DOWNLOADMANAGER_GETBYTESDOWNLOADED       = 120,
		API_DOWNLOADMANAGER_GETBUFFER                = 130,
		API_DOWNLOADMANAGER_CANCELDOWNLOAD           = 140,
		API_DOWNLOADMANAGER_RETAINDOWNLOAD           = 150,
		API_DOWNLOADMANAGER_RELEASEDOWNLOAD          = 160,
		API_DOWNLOADMANAGER_REGISTERSTATUSCALLBACK   = 170,
		API_DOWNLOADMANAGER_UNREGISTERSTATUSCALLBACK = 180,
		API_DOWNLOADMANAGER_GETSOURCE                = 190,
		API_DOWNLOADMANAGER_GETTITLE                 = 200,
		API_DOWNLOADMANAGER_RESUMEPENDINGDOWNLOAD    = 210,
		API_DOWNLOADMANAGER_ISPENDING                = 220,
	};

	enum
	{
		DOWNLOADEX_TEMPFILE            = 0,      // download as a temporary file
		DOWNLOADEX_BUFFER              = 1,      // download to memory
		DOWNLOADEX_CALLBACK            = 2,      // send data to OnData callback
		DOWNLOADEX_MASK_DOWNLOADMETHOD = 0x3,
		DOWNLOADEX_PENDING             = 0xF00,
		DOWNLOADEX_UI                  = 0xF000, // show up in the download manager UI
	};

	enum
	{
		TICK_NODATA       = -2, // not necessarily an error, just means no data this time around
		TICK_FINISHED     = -1,
		TICK_SUCCESS      = 0,
		TICK_FAILURE      = 1,
		TICK_TIMEOUT      = 2,
		TICK_CANT_CONNECT = 3,
		TICK_WRITE_ERROR  = 4,
		TICK_CONNECTING   = 5,
		TICK_CONNECTED    = 6,

	};
};


inline DownloadToken api_downloadManager::Download( const char *url, ifc_downloadManagerCallback *callback )
{
	return _call( API_DOWNLOADMANAGER_DOWNLOAD, (DownloadToken *)0, url, callback );
}

inline DownloadToken api_downloadManager::DownloadEx( const char *url, ifc_downloadManagerCallback *callback, int flags )
{
	return _call( API_DOWNLOADMANAGER_DOWNLOADEX, (DownloadToken *)0, url, callback, flags );
}

inline api_httpreceiver *api_downloadManager::GetReceiver( DownloadToken token )
{
	return _call( API_DOWNLOADMANAGER_GETRECEIVER, (api_httpreceiver *)0, token );
}

inline const wchar_t *api_downloadManager::GetLocation( DownloadToken token )
{
	return _call( API_DOWNLOADMANAGER_GETLOCATION, (const wchar_t *)0, token );
}

inline void api_downloadManager::SetLocation( DownloadToken token, const wchar_t *p_location )
{
	_voidcall( API_DOWNLOADMANAGER_SETLOCATION, token, p_location );
}

inline const char *api_downloadManager::GetExtention( DownloadToken token )
{
	return _call( API_DOWNLOADMANAGER_GETEXTENTION, (const char *)0, token );
}

inline const char *api_downloadManager::GetUrl( DownloadToken token )
{
	return _call( API_DOWNLOADMANAGER_GETURL, (const char *)0, token );
}

inline uint64_t api_downloadManager::GetBytesDownloaded( DownloadToken token )
{
	return _call( API_DOWNLOADMANAGER_GETBYTESDOWNLOADED, (uint64_t)0, token );
}

inline int api_downloadManager::GetBuffer( DownloadToken token, void **buffer, size_t *bufferLength )
{
	return _call( API_DOWNLOADMANAGER_GETBUFFER, (int)1, token, buffer, bufferLength );
}

inline void api_downloadManager::ResumePendingDownload( DownloadToken token )
{
	_voidcall( API_DOWNLOADMANAGER_RESUMEPENDINGDOWNLOAD, token );
}

inline void api_downloadManager::CancelDownload( DownloadToken token )
{
	_voidcall( API_DOWNLOADMANAGER_CANCELDOWNLOAD, token );
}

inline void api_downloadManager::RetainDownload( DownloadToken token )
{
	_voidcall( API_DOWNLOADMANAGER_RETAINDOWNLOAD, token );
}

inline void api_downloadManager::ReleaseDownload( DownloadToken token )
{
	_voidcall( API_DOWNLOADMANAGER_RELEASEDOWNLOAD, token );
}


inline void api_downloadManager::RegisterStatusCallback( ifc_downloadManagerCallback *callback )
{
	_voidcall( API_DOWNLOADMANAGER_REGISTERSTATUSCALLBACK, callback );
}

inline void api_downloadManager::UnregisterStatusCallback( ifc_downloadManagerCallback *callback )
{
	_voidcall( API_DOWNLOADMANAGER_UNREGISTERSTATUSCALLBACK, callback );
}


inline const wchar_t *api_downloadManager::GetSource( DownloadToken token )
{
	return _call( API_DOWNLOADMANAGER_GETSOURCE, (const wchar_t *)0, token );
}

inline const wchar_t *api_downloadManager::GetTitle( DownloadToken token )
{
	return _call( API_DOWNLOADMANAGER_GETTITLE, (const wchar_t *)0, token );
}

inline bool api_downloadManager::IsPending( DownloadToken token )
{
	return _call( API_DOWNLOADMANAGER_ISPENDING, (bool)0, token );
}


// {9E5E732A-C612-489d-AB52-1501E1AF1710}
static const GUID DownloadManagerGUID =
{ 0x9e5e732a, 0xc612, 0x489d, { 0xab, 0x52, 0x15, 0x1, 0xe1, 0xaf, 0x17, 0x10 } };

extern api_downloadManager *g_downloadManagerApi;

#ifndef WAC_API_DOWNLOADMANAGER
#define WAC_API_DOWNLOADMANAGER g_downloadManagerApi
#endif // !WAC_API_DOWNLOADMANAGER

#endif // !NULLSOFT_WAC_DOWNLOAD_MANAGER_API_DOWNLOADMANAGER_H