2 * cabextract interface for acquiration installation utility
3 * Copyright (C) 2003 Jan Kratochvil <project-captive@jankratochvil.net>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; exactly version 2 of June 1991 is required
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include "cabinet.h" /* self */
23 #include <glib/gmessages.h>
24 #include <libgnomevfs/gnome-vfs-file-size.h>
25 #include <libgnomevfs/gnome-vfs-ops.h>
26 #include "cabextract/cabextract.h"
27 #include "captivemodid.h"
28 #include "moduriload.h"
35 #include "cabinet-memory.h"
37 #include <captive/macros.h>
41 #define ACQUIRE_CABINET_READ_RAW_READ_TRY_MAX 5
42 #define ACQUIRE_CABINET_READ_RAW_READ_TIMEOUT 20
43 #define ACQUIRE_CABINET_READ_RAW_READ_ITER_SEC 0
44 #define ACQUIRE_CABINET_READ_RAW_READ_ITER_USEC 100000
47 #define ACQUIRE_CABINET_READ_RAW_READ_TIMEOUT_ITERS \
48 ((ACQUIRE_CABINET_READ_RAW_READ_TIMEOUT *1000000LL) \
49 /(ACQUIRE_CABINET_READ_RAW_READ_ITER_SEC*1000000LL+ACQUIRE_CABINET_READ_RAW_READ_ITER_USEC))
52 void acquire_cabinet_seek(struct acquire_cabinet *acquire_cabinet,GnomeVFSFileOffset offset)
54 g_return_if_fail(acquire_cabinet!=NULL);
56 /* Do not: (*ui_progress)(acquire_cabinet->uri);
57 * as we currently extract some specific file out of it.
61 acquire_cabinet->offset=offset;
64 void acquire_cabinet_seek_skip(struct acquire_cabinet *acquire_cabinet,GnomeVFSFileOffset offset)
66 g_return_if_fail(acquire_cabinet!=NULL);
70 acquire_cabinet->offset+=offset;
73 GnomeVFSFileOffset acquire_cabinet_tell(struct acquire_cabinet *acquire_cabinet)
75 g_return_val_if_fail(acquire_cabinet!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
79 return acquire_cabinet->offset;
82 static guint handler_SIGALRM_hits;
83 static sigjmp_buf handler_SIGALRM_sigjmp_buf;
85 static void handler_SIGALRM(int signo)
87 g_return_if_fail(signo==SIGALRM);
89 /* Try to abort the read(2) call first.
90 * If it already read something it will return the partially read data.
91 * Otherwise gnome_vfs_inet_connection_read() will loop back to retry read(2)
92 * and we will abort it after 1 second. OK, some data may be read that time
95 if (handler_SIGALRM_hits++<ACQUIRE_CABINET_READ_RAW_READ_TIMEOUT_ITERS
96 && !(*ui_progress)(NULL))
99 siglongjmp(handler_SIGALRM_sigjmp_buf,1); /* 1; meaning: !=0 */
102 /* FIXME: This is hack.
103 * Correct way would be to use 'GnomeVFSCancellation'
104 * to abort 'GnomeVFSInetConnection' acting as 'GnomeVFSSocket'.
105 * This abort should be handled from 'http' handler
106 * but gnome_vfs_cancellation_cancel() cannot be invoked from
107 * the asynchronous slave thread.
109 static GnomeVFSResult acquire_cabinet_read_raw
110 (struct acquire_cabinet *acquire_cabinet,gpointer buffer,GnomeVFSFileSize bytes,GnomeVFSFileSize *bytes_read,
111 GnomeVFSFileOffset offset)
115 g_return_val_if_fail(acquire_cabinet!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
116 g_return_val_if_fail(buffer!=NULL || bytes==0,GNOME_VFS_ERROR_BAD_PARAMETERS);
117 g_return_val_if_fail(bytes_read!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
122 return GNOME_VFS_ERROR_EOF;
124 while (try++<=ACQUIRE_CABINET_READ_RAW_READ_TRY_MAX) {
125 GnomeVFSResult errvfsresult;
126 GnomeVFSHandle *handle_new;
127 struct sigaction oldact;
129 struct itimerval itimerval;
130 GnomeVFSFileSize offset_current;
132 if ((*ui_progress)(NULL))
133 return GNOME_VFS_ERROR_INTERRUPTED;
136 handler_SIGALRM_sigjmp_buf, /* env */
137 TRUE)) { /* savesigs */
138 handler_SIGALRM_hits=0;
140 SIGALRM, /* signum */
142 &oldact); /* oldact */
144 signal(SIGALRM,handler_SIGALRM);
145 itimerval.it_interval.tv_sec=ACQUIRE_CABINET_READ_RAW_READ_ITER_SEC;
146 itimerval.it_interval.tv_usec=ACQUIRE_CABINET_READ_RAW_READ_ITER_USEC;
147 itimerval.it_value=itimerval.it_interval;
149 ITIMER_REAL, /* which */
150 &itimerval, /* value */
153 /* Optimization avoid resetting connection
154 * in neon "http" handler of: FC4 gnome-vfs2-2.10.0-5
155 * http://bugzilla.gnome.org/show_bug.cgi?id=324984
157 errvfsresult=gnome_vfs_tell(*acquire_cabinet->handlep,&offset_current);
158 if (GNOME_VFS_OK==errvfsresult && (GnomeVFSFileOffset)offset_current!=offset)
159 errvfsresult=gnome_vfs_seek(*acquire_cabinet->handlep,GNOME_VFS_SEEK_START,offset);
160 if (GNOME_VFS_OK==errvfsresult)
161 errvfsresult=gnome_vfs_read(*acquire_cabinet->handlep,buffer,bytes,bytes_read);
164 errvfsresult=GNOME_VFS_ERROR_INTERRUPTED;
165 itimerval.it_interval.tv_sec=0;
166 itimerval.it_interval.tv_usec=0;
167 itimerval.it_value=itimerval.it_interval;
169 ITIMER_REAL, /* which */
170 &itimerval, /* value */
174 SIGALRM, /* signum */
178 if (errvfsresult==GNOME_VFS_OK) {
179 g_assert(*bytes_read>0);
183 /* Reopen '*acquire_cabinet->handlep' */
184 g_assert(acquire_cabinet->handle_uri!=NULL);
185 if (GNOME_VFS_OK==(errvfsresult=gnome_vfs_open_uri(&handle_new,acquire_cabinet->handle_uri,
186 GNOME_VFS_OPEN_READ|GNOME_VFS_OPEN_RANDOM))) {
187 gnome_vfs_close(*acquire_cabinet->handlep); /* errors ignored */
188 *acquire_cabinet->handlep=handle_new;
192 return GNOME_VFS_ERROR_IO;
195 #define ACQUIRE_CABINET_BYTE_CACHED(acquire_cabinet,pos) (!(acquire_cabinet)->base_cached \
196 || (acquire_cabinet)->base_cached[(pos)/8] & 1<<((pos)&7))
197 #define ACQUIRE_CABINET_SET_BYTE_CACHED(acquire_cabinet,pos) ((acquire_cabinet)->base_cached[(pos)/8] |= 1<<((pos)&7))
199 GnomeVFSResult acquire_cabinet_read
200 (struct acquire_cabinet *acquire_cabinet,gpointer buffer,GnomeVFSFileSize bytes,GnomeVFSFileSize *bytes_read)
202 GnomeVFSFileOffset offset_start,offset_end,read_behind;
203 GnomeVFSResult errvfsresult;
204 GnomeVFSFileSize bytes_read_now;
206 g_return_val_if_fail(acquire_cabinet!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
207 g_return_val_if_fail(buffer!=NULL || bytes==0,GNOME_VFS_ERROR_BAD_PARAMETERS);
211 if ((*ui_progress)(NULL))
212 return GNOME_VFS_ERROR_INTERRUPTED;
214 bytes=MAX(0,MIN(bytes,acquire_cabinet->size-acquire_cabinet->offset));
216 return GNOME_VFS_ERROR_EOF;
219 read_behind =acquire_cabinet->offset+bytes;
221 /* GnomeVFS block transfer: */
222 offset_start=acquire_cabinet->offset;
223 offset_end =acquire_cabinet->offset;
224 while (offset_end<read_behind && !ACQUIRE_CABINET_BYTE_CACHED(acquire_cabinet,offset_end))
226 if (offset_end>offset_start) {
227 errvfsresult=acquire_cabinet_read_raw(acquire_cabinet,
228 acquire_cabinet->base+offset_start,offset_end-offset_start,&bytes_read_now,offset_start);
229 if (errvfsresult!=GNOME_VFS_OK)
231 g_assert(bytes_read_now>0);
232 acquire_cabinet->cabinet_done+=bytes_read_now;
234 (*ui_progress_bar)(acquire_cabinet->cabinet_done,acquire_cabinet->cabinet_used);
235 while (bytes_read_now) {
236 ACQUIRE_CABINET_SET_BYTE_CACHED(acquire_cabinet,offset_start);
242 /* Memory block transfer: */
243 offset_start=acquire_cabinet->offset;
244 offset_end =acquire_cabinet->offset;
245 while (offset_end<read_behind && ACQUIRE_CABINET_BYTE_CACHED(acquire_cabinet,offset_end))
247 memcpy(buffer,acquire_cabinet->base+offset_start,offset_end-offset_start);
249 *bytes_read+=offset_end-offset_start;
250 buffer+=offset_end-offset_start;
251 bytes-=offset_end-offset_start;
252 acquire_cabinet->offset=offset_end;
258 static void acquire_cabinet_set_uri(struct acquire_cabinet *acquire_cabinet,GnomeVFSURI *uri)
260 GnomeVFSURI *uri_cabextract;
262 g_return_if_fail(acquire_cabinet!=NULL);
263 g_return_if_fail(uri!=NULL);
265 /* FIXME: HACK: Use proper 'cabextract' scheme after it gets implemented.
266 * GnomeVFS will return NULL on gnome_vfs_uri_new() with scheme not available.
268 uri_cabextract=gnome_vfs_uri_new("file://");
269 g_assert(uri_cabextract->parent==NULL);
270 /* Do not: g_assert(!strcmp(uri_cabextract->method_string,"file"));
271 * uri_cabextract->method_string=g_strdup("cabextract");
272 * as it will just strip such anchor. FIXME: Why?
275 uri_cabextract->parent=gnome_vfs_uri_dup(uri);
277 acquire_cabinet->uri=uri_cabextract;
278 acquire_cabinet->handle_uri=gnome_vfs_uri_ref(uri);
279 acquire_cabinet->filename=gnome_vfs_uri_to_string(acquire_cabinet->uri,GNOME_VFS_URI_HIDE_PASSWORD);
282 struct acquire_cabinet *acquire_cabinet_new_from_memory
283 (gconstpointer file_base,size_t file_length,GnomeVFSURI *uri,gint cabinet_used)
285 struct acquire_cabinet *r;
287 g_return_val_if_fail(file_base!=NULL,NULL);
288 g_return_val_if_fail(uri!=NULL,NULL);
291 r->base=(/* de-const */ gpointer)file_base;
296 acquire_cabinet_set_uri(r,uri);
298 r->cabinet_used=cabinet_used;
299 r->memory=acquire_cabinet_memory_object_new();
304 struct acquire_cabinet *acquire_cabinet_new_from_handle
305 (GnomeVFSHandle **handlep,GnomeVFSFileInfo *file_info,GnomeVFSURI *uri,gint cabinet_used)
307 struct acquire_cabinet *r;
309 g_return_val_if_fail(handlep!=NULL,NULL);
310 g_return_val_if_fail(*handlep!=NULL,NULL);
311 g_return_val_if_fail(file_info!=NULL,NULL);
312 g_return_val_if_fail(uri!=NULL,NULL);
315 if (MAP_FAILED==(r->base=mmap(
317 CAPTIVE_ROUND_UP64(file_info->size,getpagesize()), /* length */
318 PROT_READ|PROT_WRITE,
319 MAP_ANONYMOUS|MAP_PRIVATE /* flags */
320 |MAP_NORESERVE, /* We will not probably not read the whole cabinet. */
321 -1, /* fd; ignored due to MAP_ANONYMOUS */
322 0))) { /* offset; ignored due to MAP_ANONYMOUS */
324 g_return_val_if_reached(NULL);
326 captive_new0n(r->base_cached,CAPTIVE_ROUND_UP64(file_info->size,8)/8);
329 r->size=file_info->size;
331 r->cabinet_used=cabinet_used;
333 acquire_cabinet_set_uri(r,uri);
334 r->memory=acquire_cabinet_memory_object_new();
339 void acquire_cabinet_free(struct acquire_cabinet *acquire_cabinet)
341 g_return_if_fail(acquire_cabinet!=NULL);
343 if (acquire_cabinet->base_cached) {
344 munmap(acquire_cabinet->base,CAPTIVE_ROUND_UP64(acquire_cabinet->size,getpagesize())); /* errors ignored */
345 g_free(acquire_cabinet->base_cached);
347 g_free((/* de-const */ gchar *)acquire_cabinet->filename);
348 gnome_vfs_uri_unref(acquire_cabinet->uri);
349 gnome_vfs_uri_unref(acquire_cabinet->handle_uri);
350 g_object_unref(acquire_cabinet->memory);
351 g_free(acquire_cabinet);
354 static struct file *file_write_fi_assertion;
355 static GByteArray *file_write_bytearray;
357 int file_write(struct file *fi, UBYTE *buf, size_t length)
359 g_return_val_if_fail(fi!=NULL,0);
360 g_return_val_if_fail(buf!=NULL || length==0,0);
362 g_return_val_if_fail(fi==file_write_fi_assertion,0);
363 g_return_val_if_fail(file_write_bytearray!=NULL,0);
365 if ((*ui_progress)(NULL))
368 g_byte_array_append(file_write_bytearray,buf,length);
370 return 1; /* success */
373 void acquire_cabinet_load(struct acquire_cabinet *acquire_cabinet)
375 struct cabinet *basecab;
376 struct file *filelist,*fi;
378 g_return_if_fail(acquire_cabinet!=NULL);
381 (*ui_progress_bar)(acquire_cabinet->cabinet_done,acquire_cabinet->cabinet_used);
383 if ((*ui_progress)(acquire_cabinet->uri))
386 acquire_cabinet_memory_object_push(acquire_cabinet->memory);
388 basecab=find_cabs_in_file(acquire_cabinet);
390 goto fail_memory_pop;
392 goto fail_memory_pop;
393 if (basecab->prevcab || basecab->nextcab)
394 goto fail_memory_pop;
396 filelist=process_files(basecab);
398 for (fi=filelist;fi;fi=fi->next) {
399 gpointer file_buffer;
403 if (!captivemodid_module_length_is_valid(fi->length))
406 uri_fi=gnome_vfs_uri_append_file_name(acquire_cabinet->uri,fi->filename);
407 if ((*ui_progress)(uri_fi)) {
408 gnome_vfs_uri_unref(uri_fi);
409 goto fail_memory_pop;
412 file_write_fi_assertion=fi;
413 file_write_bytearray=g_byte_array_new();
414 /* extract_file() returns 1 for success. */
415 errint=extract_file(fi,
416 0, /* lower; ignored now */
418 NULL); /* dir; ignored now */
419 if (!errint || fi->length!=file_write_bytearray->len) {
420 g_byte_array_free(file_write_bytearray,
421 TRUE); /* free_segment */
422 gnome_vfs_uri_unref(uri_fi);
424 goto fail_memory_pop;
427 file_buffer=g_byte_array_free(file_write_bytearray,
428 FALSE); /* free_segment */
429 mod_uri_load_file_from_memory(file_buffer,fi->length,uri_fi);
430 gnome_vfs_uri_unref(uri_fi);
437 acquire_cabinet_memory_object_pop(acquire_cabinet->memory);