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
|
/***************************************************************************
* downloader.c
*
* Copyright 2005 Ian McIntosh
* ian_mcintosh@linuxadvocate.org
****************************************************************************/
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Library General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
/*
Purpose of downloadmanager.c:
- A general purpose, easy to use, asyncronous download manager.
- Hand it URLs, and it calls your callback function when it's done.
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <libgnomevfs/gnome-vfs.h>
#include <gnome.h>
#include "downloadmanager.h"
#define TEMP_FILE_TEMPLATE ("roadster_download_XXXXXX") // format of temp files
typedef struct {
gchar* pszRemoteFilePath;
gchar* pszLocalFilePath; // will be NULL until file moves into 'active' list
gint nBytesDownloaded; // a count
downloadmanager_t* pDownloadManager; // a handy pointer to the parent
GnomeVFSAsyncHandle* pGnomeVFSHandle;
DownloadManagerCallbackFileResult pCallbackFileResult; // called when file succeeds or fails
} download_t;
//
// prototypes
//
static gboolean _downloadmanager_begin_download(download_t* pDownload);
static void _downloadmanager_move_pending_to_active(downloadmanager_t* pDownloadManager);
//
// Public API
//
downloadmanager_t* downloadmanager_new(gint nMaxConcurrentActive)
{
downloadmanager_t* pNew = g_new0(downloadmanager_t, 1);
pNew->pActiveArray = g_ptr_array_new();
pNew->pPendingArray = g_ptr_array_new();
pNew->nMaxConcurrentActive = nMaxConcurrentActive;
return pNew;
}
void downloadmanager_add_uri(downloadmanager_t* pDownloadManager, const gchar* pszRemoteFilePath, DownloadManagerCallbackFileResult pCallbackFileResult)
{
g_assert(pDownloadManager != NULL);
g_assert(pszRemoteFilePath != NULL);
g_assert(pCallbackFileResult != NULL);
download_t* pNewDownload = g_new0(download_t, 1);
pNewDownload->pszRemoteFilePath = g_strdup(pszRemoteFilePath);
pNewDownload->pCallbackFileResult = pCallbackFileResult;
pNewDownload->pDownloadManager = pDownloadManager;
g_ptr_array_add(pDownloadManager->pPendingArray, pNewDownload);
_downloadmanager_move_pending_to_active(pDownloadManager);
}
//
// Private functions
//
static void _downloadmanager_move_pending_to_active(downloadmanager_t* pDownloadManager)
{
// Check to see if we can add any pending files to active list
if((pDownloadManager->pActiveArray->len < pDownloadManager->nMaxConcurrentActive) && (pDownloadManager->pPendingArray->len > 0)) {
// time to promote one from pending
download_t* pNext = g_ptr_array_index(pDownloadManager->pPendingArray, 0);
if(_downloadmanager_begin_download(pNext)) {
g_ptr_array_remove(pDownloadManager->pPendingArray, pNext);
g_ptr_array_add(pDownloadManager->pActiveArray, pNext);
}
}
}
// static void _downloader_gnome_vfs_close_callback(GnomeVFSAsyncHandle *_unused, GnomeVFSResult unused, gpointer ___unused)
// {
// //g_print("downloader: a file has been closed\n");
// }
static void _downloadmanager_download_free(downloadmanager_t* pDownloadManager, download_t* pDownload)
{
// Empty struct
g_free(pDownload->pszRemoteFilePath);
g_free(pDownload->pszLocalFilePath);
if(pDownload->pGnomeVFSHandle != NULL) {
// XXX: do we need to close this?
// gnome_vfs_async_close(pDownload->pGnomeVFSHandle, _downloader_gnome_vfs_close_callback, NULL);
}
// XXX: store a 'state' so we know which array it's in?
g_ptr_array_remove_fast(pDownloadManager->pActiveArray, pDownload);
g_ptr_array_remove(pDownloadManager->pPendingArray, pDownload);
// Free struct
g_free(pDownload);
}
static gint _downloadmanager_gnome_vfs_progress_callback(GnomeVFSAsyncHandle *pHandle, GnomeVFSXferProgressInfo *pInfo, download_t* pDownload)
{
g_assert(pHandle != NULL);
g_assert(pInfo != NULL);
g_assert(pDownload != NULL);
pDownload->nBytesDownloaded = pInfo->bytes_copied;
if(pInfo->phase == GNOME_VFS_XFER_PHASE_COMPLETED) {
g_print("downloader: downloaded '%s' to '%s' (%d bytes)\n", pDownload->pszRemoteFilePath, pDownload->pszLocalFilePath, pDownload->nBytesDownloaded);
// Call user-supplied callback
pDownload->pCallbackFileResult(pDownload->pszRemoteFilePath, DOWNLOADMANAGER_RESULT_SUCCESS, pDownload->pszLocalFilePath);
// callback shouldn't leave the file in the temp directory
if(g_file_test(pDownload->pszLocalFilePath, G_FILE_TEST_EXISTS)) {
g_warning("downloader: callback failed to move/delete local file '%s' (from remote '%s')\n", pDownload->pszLocalFilePath, pDownload->pszRemoteFilePath);
}
downloadmanager_t* pDownloadManager = pDownload->pDownloadManager;
_downloadmanager_download_free(pDownloadManager, pDownload);
//
_downloadmanager_move_pending_to_active(pDownloadManager);
}
// XXX: what other statuses messages do we care about? (failed?)
return 1; // XXX: added a return value without testing-- is this the right value?
}
static gboolean _downloadmanager_begin_download(download_t* pDownload)
{
g_assert(pDownload != NULL);
//g_print("downloader: beginning download of %s\n", pDownload->pszRemoteFilePath);
g_assert(pDownload->pszLocalFilePath == NULL);
gint nHandle = g_file_open_tmp(TEMP_FILE_TEMPLATE, &(pDownload->pszLocalFilePath), NULL);
if(nHandle == -1) {
g_warning("downloader: failed to create a temporary file\n");
return FALSE;
}
g_assert(pDownload->pszLocalFilePath != NULL);
close(nHandle); // we don't use the file here. gnome-vfs overwrites it.
//g_print("downloader: using temp file '%s'\n", pDownload->pszLocalFilePath);
GnomeVFSURI* pSrcURI = gnome_vfs_uri_new(pDownload->pszRemoteFilePath);
GList* pSrcList = g_list_prepend(pSrcList, pSrcURI);
GnomeVFSURI* pDestURI = gnome_vfs_uri_new(pDownload->pszLocalFilePath);
GList* pDestList = g_list_prepend(pDestList, pDestURI);
GnomeVFSResult res = gnome_vfs_async_xfer(&(pDownload->pGnomeVFSHandle),
pSrcList, pDestList,
GNOME_VFS_XFER_DEFAULT,
GNOME_VFS_XFER_ERROR_MODE_ABORT,
GNOME_VFS_XFER_OVERWRITE_MODE_REPLACE, // overwrite the tmp file we just made.
GNOME_VFS_PRIORITY_MIN,
(GnomeVFSAsyncXferProgressCallback)_downloadmanager_gnome_vfs_progress_callback,
(gpointer)pDownload, // callback userdata
NULL,
NULL);
gnome_vfs_uri_unref(pSrcURI);
gnome_vfs_uri_unref(pDestURI);
g_list_free(pSrcList);
g_list_free(pDestList);
if(res != GNOME_VFS_OK) {
// return the download_t to a 'pending' state
g_free(pDownload->pszLocalFilePath); pDownload->pszLocalFilePath = NULL;
g_assert(pDownload->pGnomeVFSHandle == NULL);
return FALSE;
}
g_assert(pDownload->pGnomeVFSHandle != NULL);
return TRUE;
}
|
