src/install/acquire/cabinet.c

   1 /* $Id$
   2  * cabextract interface for acquiration installation utility
   3  * Copyright (C) 2003 Jan Kratochvil <project-captive@jankratochvil.net>
   4  *
   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
   8  *
   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.
  13  *
  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
  17  */
  18
  19
  20 #include "config.h"
  21
  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"
  29 #include <sys/mman.h>
  30 #include <unistd.h>
  31 #include "main.h"
  32 #include <signal.h>
  33 #include <setjmp.h>
  34 #include <sys/time.h>
  35 #include "cabinet-memory.h"
  36
  37 #include <captive/macros.h>
  38
  39
  40 /* Config: */
  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
  45
  46
  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))
  50
  51
  52 void acquire_cabinet_seek(struct acquire_cabinet *acquire_cabinet,GnomeVFSFileOffset offset)
  53 {
  54         g_return_if_fail(acquire_cabinet!=NULL);
  55
  56         /* Do not: (*ui_progress)(acquire_cabinet->uri);
  57          * as we currently extract some specific file out of it.
  58          */
  59         (*ui_progress)(NULL);
  60
  61         acquire_cabinet->offset=offset;
  62 }
  63
  64 void acquire_cabinet_seek_skip(struct acquire_cabinet *acquire_cabinet,GnomeVFSFileOffset offset)
  65 {
  66         g_return_if_fail(acquire_cabinet!=NULL);
  67
  68         (*ui_progress)(NULL);
  69
  70         acquire_cabinet->offset+=offset;
  71 }
  72
  73 GnomeVFSFileOffset acquire_cabinet_tell(struct acquire_cabinet *acquire_cabinet)
  74 {
  75         g_return_val_if_fail(acquire_cabinet!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
  76
  77         (*ui_progress)(NULL);
  78
  79         return acquire_cabinet->offset;
  80 }
  81
  82 static guint handler_SIGALRM_hits;
  83 static sigjmp_buf handler_SIGALRM_sigjmp_buf;
  84
  85 static void handler_SIGALRM(int signo)
  86 {
  87         g_return_if_fail(signo==SIGALRM);
  88
  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
  93          * but who cares.
  94          */
  95         if (handler_SIGALRM_hits++<ACQUIRE_CABINET_READ_RAW_READ_TIMEOUT_ITERS
  96                         && !(*ui_progress)(NULL))
  97                 return;
  98
  99         siglongjmp(handler_SIGALRM_sigjmp_buf,1);       /* 1; meaning: !=0 */
 100 }
 101
 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'/'httpcaptive' handler
 106  * but gnome_vfs_cancellation_cancel() cannot be invoked from
 107  * the asynchronous slave thread.
 108  */
 109 static GnomeVFSResult acquire_cabinet_read_raw
 110                 (struct acquire_cabinet *acquire_cabinet,gpointer buffer,GnomeVFSFileSize bytes,GnomeVFSFileSize *bytes_read,
 111                 GnomeVFSFileOffset offset)
 112 {
 113 gint try=0;
 114
 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);
 118
 119         *bytes_read=0;
 120
 121         if (!bytes)
 122                 return GNOME_VFS_ERROR_EOF;
 123
 124         while (try++<=ACQUIRE_CABINET_READ_RAW_READ_TRY_MAX) {
 125 GnomeVFSResult errvfsresult;
 126 GnomeVFSHandle *handle_new;
 127 struct sigaction oldact;
 128 int errint;
 129 struct itimerval itimerval;
 130
 131                 if ((*ui_progress)(NULL))
 132                         return GNOME_VFS_ERROR_INTERRUPTED;
 133
 134                 if (!sigsetjmp(
 135                                 handler_SIGALRM_sigjmp_buf,     /* env */
 136                                 TRUE)) {        /* savesigs */
 137                         handler_SIGALRM_hits=0;
 138                         errint=sigaction(
 139                                         SIGALRM,        /* signum */
 140                                         NULL,   /* act */
 141                                         &oldact);       /* oldact */
 142                         g_assert(errint==0);
 143                         signal(SIGALRM,handler_SIGALRM);
 144                         itimerval.it_interval.tv_sec=ACQUIRE_CABINET_READ_RAW_READ_ITER_SEC;
 145                         itimerval.it_interval.tv_usec=ACQUIRE_CABINET_READ_RAW_READ_ITER_USEC;
 146                         itimerval.it_value=itimerval.it_interval;
 147                         errint=setitimer(
 148                                         ITIMER_REAL,    /* which */
 149                                         &itimerval,     /* value */
 150                                         NULL);  /* ovalue */
 151                         g_assert(errint==0);
 152                         errvfsresult=gnome_vfs_seek(*acquire_cabinet->handlep,GNOME_VFS_SEEK_START,offset);
 153                         if (GNOME_VFS_OK==errvfsresult)
 154                                 errvfsresult=gnome_vfs_read(*acquire_cabinet->handlep,buffer,bytes,bytes_read);
 155                         }
 156                 else
 157                         errvfsresult=GNOME_VFS_ERROR_INTERRUPTED;
 158                 itimerval.it_interval.tv_sec=0;
 159                 itimerval.it_interval.tv_usec=0;
 160                 itimerval.it_value=itimerval.it_interval;
 161                 errint=setitimer(
 162                                 ITIMER_REAL,    /* which */
 163                                 &itimerval,     /* value */
 164                                 NULL);  /* ovalue */
 165                 g_assert(errint==0);
 166                 errint=sigaction(
 167                                 SIGALRM,        /* signum */
 168                                 &oldact,        /* act */
 169                                 NULL);  /* oldact */
 170                 g_assert(errint==0);
 171                 if (errvfsresult==GNOME_VFS_OK) {
 172                         g_assert(*bytes_read>0);
 173                         return GNOME_VFS_OK;
 174                         }
 175
 176                 /* Reopen '*acquire_cabinet->handlep' */
 177                 g_assert(acquire_cabinet->handle_uri!=NULL);
 178                 if (GNOME_VFS_OK==(errvfsresult=gnome_vfs_open_uri(&handle_new,acquire_cabinet->handle_uri,GNOME_VFS_OPEN_READ))) {
 179                         gnome_vfs_close(*acquire_cabinet->handlep);     /* errors ignored */
 180                         *acquire_cabinet->handlep=handle_new;
 181                         }
 182                 }
 183
 184         return GNOME_VFS_ERROR_IO;
 185 }
 186
 187 #define ACQUIRE_CABINET_BYTE_CACHED(acquire_cabinet,pos)     (!(acquire_cabinet)->base_cached \
 188                                                            || (acquire_cabinet)->base_cached[(pos)/8] &  1<<((pos)&7))
 189 #define ACQUIRE_CABINET_SET_BYTE_CACHED(acquire_cabinet,pos) ((acquire_cabinet)->base_cached[(pos)/8] |= 1<<((pos)&7))
 190
 191 GnomeVFSResult acquire_cabinet_read
 192                 (struct acquire_cabinet *acquire_cabinet,gpointer buffer,GnomeVFSFileSize bytes,GnomeVFSFileSize *bytes_read)
 193 {
 194 GnomeVFSFileOffset offset_start,offset_end,read_behind;
 195 GnomeVFSResult errvfsresult;
 196 GnomeVFSFileSize bytes_read_now;
 197
 198         g_return_val_if_fail(acquire_cabinet!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 199         g_return_val_if_fail(buffer!=NULL || bytes==0,GNOME_VFS_ERROR_BAD_PARAMETERS);
 200
 201         *bytes_read=0;
 202
 203         if ((*ui_progress)(NULL))
 204                 return GNOME_VFS_ERROR_INTERRUPTED;
 205
 206         bytes=MAX(0,MIN(bytes,acquire_cabinet->size-acquire_cabinet->offset));
 207         if (!bytes)
 208                 return GNOME_VFS_ERROR_EOF;
 209
 210         while (bytes) {
 211                 read_behind =acquire_cabinet->offset+bytes;
 212
 213                 /* GnomeVFS block transfer: */
 214                 offset_start=acquire_cabinet->offset;
 215                 offset_end  =acquire_cabinet->offset;
 216                 while (offset_end<read_behind && !ACQUIRE_CABINET_BYTE_CACHED(acquire_cabinet,offset_end))
 217                         offset_end++;
 218                 if (offset_end>offset_start) {
 219                         errvfsresult=acquire_cabinet_read_raw(acquire_cabinet,
 220                                         acquire_cabinet->base+offset_start,offset_end-offset_start,&bytes_read_now,offset_start);
 221                         if (errvfsresult!=GNOME_VFS_OK)
 222                                 return errvfsresult;
 223                         g_assert(bytes_read_now>0);
 224                         acquire_cabinet->cabinet_done+=bytes_read_now;
 225                         if (ui_progress_bar)
 226                                 (*ui_progress_bar)(acquire_cabinet->cabinet_done,acquire_cabinet->cabinet_used);
 227                         while (bytes_read_now) {
 228                                 ACQUIRE_CABINET_SET_BYTE_CACHED(acquire_cabinet,offset_start);
 229                                 offset_start++;
 230                                 bytes_read_now--;
 231                                 }
 232                         }
 233
 234                 /* Memory block transfer: */
 235                 offset_start=acquire_cabinet->offset;
 236                 offset_end  =acquire_cabinet->offset;
 237                 while (offset_end<read_behind && ACQUIRE_CABINET_BYTE_CACHED(acquire_cabinet,offset_end))
 238                         offset_end++;
 239                 memcpy(buffer,acquire_cabinet->base+offset_start,offset_end-offset_start);
 240                 if (bytes_read)
 241                         *bytes_read+=offset_end-offset_start;
 242                 buffer+=offset_end-offset_start;
 243                 bytes-=offset_end-offset_start;
 244                 acquire_cabinet->offset=offset_end;
 245                 }
 246
 247         return GNOME_VFS_OK;
 248 }
 249
 250 static void acquire_cabinet_set_uri(struct acquire_cabinet *acquire_cabinet,GnomeVFSURI *uri)
 251 {
 252 GnomeVFSURI *uri_cabextract;
 253
 254         g_return_if_fail(acquire_cabinet!=NULL);
 255         g_return_if_fail(uri!=NULL);
 256
 257         /* FIXME: HACK: Use proper 'cabextract' scheme after it gets implemented.
 258          * GnomeVFS will return NULL on gnome_vfs_uri_new() with scheme not available.
 259          */
 260         uri_cabextract=gnome_vfs_uri_new("file://");
 261         g_assert(uri_cabextract->parent==NULL);
 262         /* Do not: g_assert(!strcmp(uri_cabextract->method_string,"file"));
 263          *         uri_cabextract->method_string=g_strdup("cabextract");
 264          * as it will just strip such anchor. FIXME: Why?
 265          */
 266
 267         uri_cabextract->parent=gnome_vfs_uri_dup(uri);
 268
 269         acquire_cabinet->uri=uri_cabextract;
 270         acquire_cabinet->handle_uri=gnome_vfs_uri_ref(uri);
 271         acquire_cabinet->filename=gnome_vfs_uri_to_string(acquire_cabinet->uri,GNOME_VFS_URI_HIDE_PASSWORD);
 272 }
 273
 274 struct acquire_cabinet *acquire_cabinet_new_from_memory
 275                 (gconstpointer file_base,size_t file_length,GnomeVFSURI *uri,gint cabinet_used)
 276 {
 277 struct acquire_cabinet *r;
 278
 279         g_return_val_if_fail(file_base!=NULL,NULL);
 280         g_return_val_if_fail(uri!=NULL,NULL);
 281
 282         captive_new(r);
 283         r->base=(/* de-const */ gpointer)file_base;
 284         r->base_cached=NULL;
 285         r->offset=0;
 286         r->handlep=NULL;
 287         r->size=file_length;
 288         acquire_cabinet_set_uri(r,uri);
 289         r->cabinet_done=0;
 290         r->cabinet_used=cabinet_used;
 291         r->memory=acquire_cabinet_memory_object_new();
 292
 293         return r;
 294 }
 295
 296 struct acquire_cabinet *acquire_cabinet_new_from_handle
 297                 (GnomeVFSHandle **handlep,GnomeVFSFileInfo *file_info,GnomeVFSURI *uri,gint cabinet_used)
 298 {
 299 struct acquire_cabinet *r;
 300
 301         g_return_val_if_fail(handlep!=NULL,NULL);
 302         g_return_val_if_fail(*handlep!=NULL,NULL);
 303         g_return_val_if_fail(file_info!=NULL,NULL);
 304         g_return_val_if_fail(uri!=NULL,NULL);
 305
 306         captive_new(r);
 307         if (MAP_FAILED==(r->base=mmap(
 308                         NULL,   /* start */
 309                         CAPTIVE_ROUND_UP64(file_info->size,getpagesize()),      /* length */
 310                         PROT_READ|PROT_WRITE,
 311                         MAP_ANONYMOUS|MAP_PRIVATE       /* flags */
 312                                         |MAP_NORESERVE, /* We will not probably not read the whole cabinet. */
 313                         -1,     /* fd; ignored due to MAP_ANONYMOUS */
 314                         0))) {  /* offset; ignored due to MAP_ANONYMOUS */
 315                 g_free(r);
 316                 g_return_val_if_reached(NULL);
 317                 }
 318         captive_new0n(r->base_cached,CAPTIVE_ROUND_UP64(file_info->size,8)/8);
 319         r->offset=0;
 320         r->handlep=handlep;
 321         r->size=file_info->size;
 322         r->cabinet_done=0;
 323         r->cabinet_used=cabinet_used;
 324
 325         /* Replace 'http://' by 'httpcaptive://' if system 'http' does not support seek(). */
 326         gnome_vfs_uri_ref(uri);
 327         if (GNOME_VFS_ERROR_NOT_SUPPORTED==gnome_vfs_seek(
 328                         *handlep,       /* handle */
 329                         GNOME_VFS_SEEK_START,   /* whence */
 330                         0)) {   /* offset */
 331 gchar *href;
 332 const gchar *href2;
 333 GnomeVFSURI *uri2;
 334
 335                 href=gnome_vfs_uri_to_string(uri,GNOME_VFS_URI_HIDE_NONE);
 336                 if (strncmp(href,"http://",strlen("http://"))) {
 337                         g_warning(_("Destination file URL not valid: %s"),href);
 338                         goto href_done;
 339                         }
 340                 href2=captive_printf_alloca("httpcaptive://%s",href+strlen("http://"));
 341                 if (!(uri2=gnome_vfs_uri_new(href2))) {
 342                         g_warning(_("'httpcaptive' GnomeVFS method not supported; install package 'gnomevfs-httpcaptive'; URL: %s"),href2);
 343                         goto href_done;
 344                         }
 345                 gnome_vfs_uri_unref(uri);
 346                 uri=uri2;
 347 href_done:;
 348                 }
 349
 350         acquire_cabinet_set_uri(r,uri);
 351         gnome_vfs_uri_unref(uri);
 352         r->memory=acquire_cabinet_memory_object_new();
 353
 354         return r;
 355 }
 356
 357 void acquire_cabinet_free(struct acquire_cabinet *acquire_cabinet)
 358 {
 359         g_return_if_fail(acquire_cabinet!=NULL);
 360
 361         if (acquire_cabinet->base_cached) {
 362                 munmap(acquire_cabinet->base,CAPTIVE_ROUND_UP64(acquire_cabinet->size,getpagesize()));  /* errors ignored */
 363                 g_free(acquire_cabinet->base_cached);
 364                 }
 365         g_free((/* de-const */ gchar *)acquire_cabinet->filename);
 366         gnome_vfs_uri_unref(acquire_cabinet->uri);
 367         gnome_vfs_uri_unref(acquire_cabinet->handle_uri);
 368         g_object_unref(acquire_cabinet->memory);
 369         g_free(acquire_cabinet);
 370 }
 371
 372 static struct file *file_write_fi_assertion;
 373 static GByteArray *file_write_bytearray;
 374
 375 int file_write(struct file *fi, UBYTE *buf, size_t length)
 376 {
 377         g_return_val_if_fail(fi!=NULL,0);
 378         g_return_val_if_fail(buf!=NULL || length==0,0);
 379
 380         g_return_val_if_fail(fi==file_write_fi_assertion,0);
 381         g_return_val_if_fail(file_write_bytearray!=NULL,0);
 382
 383         if ((*ui_progress)(NULL))
 384                 return 0;
 385
 386         g_byte_array_append(file_write_bytearray,buf,length);
 387
 388         return 1;       /* success */
 389 }
 390
 391 void acquire_cabinet_load(struct acquire_cabinet *acquire_cabinet)
 392 {
 393 struct cabinet *basecab;
 394 struct file *filelist,*fi;
 395
 396         g_return_if_fail(acquire_cabinet!=NULL);
 397
 398         if (ui_progress_bar)
 399                 (*ui_progress_bar)(acquire_cabinet->cabinet_done,acquire_cabinet->cabinet_used);
 400
 401         if ((*ui_progress)(acquire_cabinet->uri))
 402                 return;
 403
 404         acquire_cabinet_memory_object_push(acquire_cabinet->memory);
 405
 406         basecab=find_cabs_in_file(acquire_cabinet);
 407         if (!basecab)
 408                 goto fail_memory_pop;
 409         if (basecab->next)
 410                 goto fail_memory_pop;
 411         if (basecab->prevcab || basecab->nextcab)
 412                 goto fail_memory_pop;
 413
 414         filelist=process_files(basecab);
 415
 416         for (fi=filelist;fi;fi=fi->next) {
 417 gpointer file_buffer;
 418 GnomeVFSURI *uri_fi;
 419 int errint;
 420
 421                 if (!captivemodid_module_length_is_valid(fi->length))
 422                         continue;
 423
 424                 uri_fi=gnome_vfs_uri_append_file_name(acquire_cabinet->uri,fi->filename);
 425                 if ((*ui_progress)(uri_fi)) {
 426                         gnome_vfs_uri_unref(uri_fi);
 427                         goto fail_memory_pop;
 428                         }
 429
 430                 file_write_fi_assertion=fi;
 431                 file_write_bytearray=g_byte_array_new();
 432                 /* extract_file() returns 1 for success. */
 433                 errint=extract_file(fi,
 434                                 0,      /* lower; ignored now */
 435                                 FALSE,  /* fix */
 436                                 NULL);  /* dir; ignored now */
 437                 if (!errint || fi->length!=file_write_bytearray->len) {
 438                         g_byte_array_free(file_write_bytearray,
 439                                         TRUE);  /* free_segment */
 440                         gnome_vfs_uri_unref(uri_fi);
 441                         if (!errint)
 442                                 goto fail_memory_pop;
 443                         continue;
 444                         }
 445                 file_buffer=g_byte_array_free(file_write_bytearray,
 446                                 FALSE); /* free_segment */
 447                 mod_uri_load_file_from_memory(file_buffer,fi->length,uri_fi);
 448                 gnome_vfs_uri_unref(uri_fi);
 449                 g_free(file_buffer);
 450     }
 451
 452         /* FALLTHRU */
 453
 454 fail_memory_pop:
 455         acquire_cabinet_memory_object_pop(acquire_cabinet->memory);
 456 }