tools/download.c

   1 /**********************************************************************
   2  Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   3    This program is free software; you can redistribute it and/or modify
   4    it under the terms of the GNU General Public License as published by
   5    the Free Software Foundation; either version 2, or (at your option)
   6    any later version.
   7
   8    This program is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11    GNU General Public License for more details.
  12 ***********************************************************************/
  13
  14 #ifdef HAVE_CONFIG_H
  15 #include <fc_config.h>
  16 #endif
  17
  18 #ifdef HAVE_SYS_TYPES_H
  19 #include <sys/types.h>
  20 #endif
  21 #ifdef HAVE_SYS_SOCKET_H
  22 #include <sys/socket.h>
  23 #endif
  24 #include <unistd.h>
  25 #include <errno.h>
  26
  27 /* utility */
  28 #include "capability.h"
  29 #include "fcintl.h"
  30 #include "log.h"
  31 #include "netintf.h"
  32 #include "netfile.h"
  33 #include "registry.h"
  34
  35 /* modinst */
  36 #include "download.h"
  37
  38 /**************************************************************************
  39   Message callback called by netfile module when downloading files.
  40 **************************************************************************/
  41 static void nf_cb(const char *msg, void *data)
  42 {
  43   dl_msg_callback mcb = (dl_msg_callback) data;
  44
  45   if (mcb != NULL) {
  46     mcb(msg);
  47   }
  48 }
  49
  50 /**************************************************************************
  51   Download modpack from a given URL
  52 **************************************************************************/
  53 const char *download_modpack(const char *URL,
  54                              const struct fcmp_params *fcmp,
  55                              dl_msg_callback mcb,
  56                              dl_pb_callback pbcb)
  57 {
  58   char local_dir[2048];
  59   char local_name[2048];
  60   int start_idx;
  61   int filenbr, total_files;
  62   struct section_file *control;
  63   const char *control_capstr;
  64   const char *baseURL;
  65   enum modpack_type type;
  66   const char *typestr;
  67   const char *mpname;
  68   const char *mpver;
  69   char fileURL[2048];
  70   const char *src_name;
  71   bool partial_failure = FALSE;
  72
  73   if (URL == NULL || URL[0] == '\0') {
  74     return _("No URL given");
  75   }
  76
  77   if (strlen(URL) < strlen(MODPACK_SUFFIX)
  78       || strcmp(URL + strlen(URL) - strlen(MODPACK_SUFFIX), MODPACK_SUFFIX)) {
  79     return _("This does not look like modpack URL");
  80   }
  81
  82   for (start_idx = strlen(URL) - strlen(MODPACK_SUFFIX);
  83        start_idx > 0 && URL[start_idx - 1] != '/';
  84        start_idx--) {
  85     /* Nothing */
  86   }
  87
  88   log_normal(_("Installing modpack %s from %s"), URL + start_idx, URL);
  89
  90   if (fcmp->inst_prefix == NULL) {
  91     return _("Cannot install to given directory hierarchy");
  92   }
  93
  94   if (mcb != NULL) {
  95     mcb(_("Downloading modpack control file."));
  96   }
  97
  98   control = netfile_get_section_file(URL, nf_cb, mcb);
  99
 100   if (control == NULL) {
 101     return _("Failed to get and parse modpack control file");
 102   }
 103
 104   control_capstr = secfile_lookup_str(control, "info.options");
 105   if (control_capstr == NULL) {
 106     secfile_destroy(control);
 107     return _("Modpack control file has no capability string");
 108   }
 109
 110   if (!has_capabilities(MODPACK_CAPSTR, control_capstr)) {
 111     log_error("Incompatible control file:");
 112     log_error("  control file options: %s", control_capstr);
 113     log_error("  supported options:    %s", MODPACK_CAPSTR);
 114
 115     secfile_destroy(control);
 116
 117     return _("Modpack control file is incompatible");
 118   }
 119
 120   mpname = secfile_lookup_str(control, "info.name");
 121   if (mpname == NULL) {
 122     return _("Modpack name not defined in control file");
 123   }
 124   mpver = secfile_lookup_str(control, "info.version");
 125   if (mpver  == NULL) {
 126     return _("Modpack version not defined in control file");
 127   }
 128
 129   typestr = secfile_lookup_str(control, "info.type");
 130   type = modpack_type_by_name(typestr, fc_strcasecmp);
 131   if (!modpack_type_is_valid(type)) {
 132     return _("Illegal modpack type");
 133   }
 134
 135   if (type == MPT_SCENARIO) {
 136     fc_snprintf(local_dir, sizeof(local_dir),
 137                 "%s/scenarios", fcmp->inst_prefix);
 138   } else {
 139     fc_snprintf(local_dir, sizeof(local_dir),
 140                 "%s/" DATASUBDIR, fcmp->inst_prefix);
 141   }
 142
 143   baseURL = secfile_lookup_str(control, "info.baseURL");
 144
 145   total_files = 0;
 146   do {
 147     src_name = secfile_lookup_str_default(control, NULL,
 148                                           "files.list%d.src", total_files);
 149
 150     if (src_name != NULL) {
 151       total_files++;
 152     }
 153   } while (src_name != NULL);
 154
 155   if (pbcb != NULL) {
 156     /* Control file already downloaded */
 157     pbcb(1, total_files + 1);
 158   }
 159
 160   filenbr = 0;
 161   for (filenbr = 0; filenbr < total_files; filenbr++) {
 162     const char *dest_name;
 163     int i;
 164     bool illegal_filename = FALSE;
 165
 166     src_name = secfile_lookup_str_default(control, NULL,
 167                                           "files.list%d.src", filenbr);
 168
 169     dest_name = secfile_lookup_str_default(control, NULL,
 170                                            "files.list%d.dest", filenbr);
 171
 172     if (dest_name == NULL || dest_name[0] == '\0') {
 173       /* Missing dest name is ok, we just default to src_name */
 174       dest_name = src_name;
 175     }
 176
 177     for (i = 0; dest_name[i] != '\0'; i++) {
 178       if (dest_name[i] == '.' && dest_name[i+1] == '.') {
 179         if (mcb != NULL) {
 180           char buf[2048];
 181
 182           fc_snprintf(buf, sizeof(buf), _("Illegal path for %s"),
 183                       dest_name);
 184           mcb(buf);
 185         }
 186         partial_failure = TRUE;
 187         illegal_filename = TRUE;
 188       }
 189     }
 190
 191     if (!illegal_filename) {
 192       fc_snprintf(local_name, sizeof(local_name),
 193                   "%s/%s", local_dir, dest_name);
 194       for (i = strlen(local_name) - 1 ; local_name[i] != '/' ; i--) {
 195         /* Nothing */
 196       }
 197       local_name[i] = '\0';
 198       if (!make_dir(local_name)) {
 199         secfile_destroy(control);
 200         return _("Cannot create required directories");
 201       }
 202       local_name[i] = '/';
 203
 204       if (mcb != NULL) {
 205         char buf[2048];
 206
 207         fc_snprintf(buf, sizeof(buf), _("Downloading %s"), src_name);
 208         mcb(buf);
 209       }
 210
 211       fc_snprintf(fileURL, sizeof(fileURL), "%s/%s", baseURL, src_name);
 212       if (!netfile_download_file(fileURL, local_name, nf_cb, mcb)) {
 213         if (mcb != NULL) {
 214           char buf[2048];
 215
 216           fc_snprintf(buf, sizeof(buf), _("Failed to download %s"),
 217                       src_name);
 218           mcb(buf);
 219         }
 220         partial_failure = TRUE;
 221       }
 222     }
 223
 224     if (pbcb != NULL) {
 225       /* Count download of control file also */
 226       pbcb(filenbr + 2, total_files + 1);
 227     }
 228   }
 229
 230   if (partial_failure) {
 231     secfile_destroy(control);
 232
 233     return _("Some parts of the modpack failed to install.");
 234   }
 235
 236   update_install_info_lists(mpname, type, mpver);
 237
 238   secfile_destroy(control);
 239
 240   return NULL;
 241 }
 242
 243 /**************************************************************************
 244   Download modpack list
 245 **************************************************************************/
 246 const char *download_modpack_list(const struct fcmp_params *fcmp,
 247                                   modpack_list_setup_cb cb,
 248                                   dl_msg_callback mcb)
 249 {
 250   struct section_file *list_file;
 251   const char *list_capstr;
 252   int modpack_count;
 253   const char *msg;
 254   const char *mp_name;
 255
 256   list_file = netfile_get_section_file(fcmp->list_url, nf_cb, mcb);
 257
 258   if (list_file == NULL) {
 259     return _("Cannot fetch and parse modpack list");
 260   }
 261
 262   list_capstr = secfile_lookup_str(list_file, "info.options");
 263   if (list_capstr == NULL) {
 264     secfile_destroy(list_file);
 265     return _("Modpack list has no capability string");
 266   }
 267
 268   if (!has_capabilities(MODLIST_CAPSTR, list_capstr)) {
 269     log_error("Incompatible modpack list file:");
 270     log_error("  list file options: %s", list_capstr);
 271     log_error("  supported options: %s", MODLIST_CAPSTR);
 272
 273     secfile_destroy(list_file);
 274
 275     return _("Modpack list is incompatible");
 276   }
 277
 278   msg = secfile_lookup_str_default(list_file, NULL, "info.message");
 279
 280   if (msg != NULL) {
 281     mcb(msg);
 282   }
 283
 284   modpack_count = 0;
 285   do {
 286     const char *mpURL;
 287     const char *mpver;
 288     const char *mplic;
 289     const char *mp_type_str;
 290     const char *mp_subtype;
 291     const char *mp_notes;
 292
 293     mp_name = secfile_lookup_str_default(list_file, NULL,
 294                                          "modpacks.list%d.name", modpack_count);
 295     mpver = secfile_lookup_str_default(list_file, NULL,
 296                                        "modpacks.list%d.version",
 297                                        modpack_count);
 298     mplic = secfile_lookup_str_default(list_file, NULL,
 299                                        "modpacks.list%d.license",
 300                                        modpack_count);
 301     mp_type_str = secfile_lookup_str_default(list_file, NULL,
 302                                              "modpacks.list%d.type",
 303                                              modpack_count);
 304     mp_subtype = secfile_lookup_str_default(list_file, NULL,
 305                                             "modpacks.list%d.subtype",
 306                                             modpack_count);
 307     mpURL = secfile_lookup_str_default(list_file, NULL,
 308                                        "modpacks.list%d.URL", modpack_count);
 309     mp_notes = secfile_lookup_str_default(list_file, NULL,
 310                                           "modpacks.list%d.notes", modpack_count);
 311
 312     if (mp_name != NULL && mpURL != NULL) {
 313       enum modpack_type type = modpack_type_by_name(mp_type_str, fc_strcasecmp);
 314       if (!modpack_type_is_valid(type)) {
 315         log_error("Illegal modpack type \"%s\"", mp_type_str ? mp_type_str : "NULL");
 316       }
 317       if (mpver == NULL) {
 318         mpver = "-";
 319       }
 320       if (mp_subtype == NULL) {
 321         mp_subtype = "-";
 322       }
 323       cb(mp_name, mpURL, mpver, mplic, type, mp_subtype, mp_notes);
 324     }
 325     modpack_count++;
 326   } while (mp_name != NULL);
 327
 328   return NULL;
 329 }