ioz.c

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   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, 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 General Public License for more details.
***********************************************************************/
 
/***********************************************************************
  An IO layer to support transparent compression/uncompression.
  (Currently only "required" functionality is supported.)
 
  There are various reasons for making this a full-blown module
  instead of just defining a few macros:
 
  - Ability to switch between compressed and uncompressed at run-time
    (zlib with compression level 0 saves uncompressed, but still with
    gzip header, so non-zlib server cannot read the savefile).
 
  - Flexibility to add other methods if desired (eg, bzip2, arbitrary
    external filter program, etc).
 
  FIXME: When zlib support _not_ included, should sanity check whether
  the first few bytes are gzip marker and complain if so.
***********************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif
 
#include "fc_prehdrs.h"
 
#include <errno.h>
#include <stdarg.h>
#include <stdio.h>
#include <string.h>
 
#ifdef FREECIV_HAVE_LIBZ
#include <zlib.h>
#endif
 
#ifdef HAVE_BZLIB_H
#include <bzlib.h>
#endif
 
#ifdef HAVE_LZMA_H
#include <lzma.h>
#endif
 
#ifdef HAVE_ZSTD_H
#include <zstd.h>
#endif
 
/* utility */
#include "log.h"
#include "mem.h"
#include "shared.h"
#include "support.h"
 
#include "ioz.h"
 
/* If you increase size of this, be sure to increase also
 * VSNP_BUF_SIZE in support.c so that this still fits in. */
#define PLAIN_FILE_BUF_SIZE (8096*1024)    // 8096kb
 
#ifdef FREECIV_HAVE_LIBBZ2
struct bzip2_struct {
  BZFILE *file;
  FILE *plain;
  int error;
  int firstbyte;
  bool eof;
};
#endif /* FREECIV_HAVE_LIBBZ2 */
 
#ifdef FREECIV_HAVE_LIBLZMA
 
#define PLAIN_FILE_BUF_SIZE_XZ PLAIN_FILE_BUF_SIZE
#define XZ_DECODER_TEST_SIZE (4*1024)      /* 4kb */
 
/* In my tests 7Mb proved to be not enough and with 10Mb decompression
   succeeded in typical case. */
#define XZ_DECODER_MEMLIMIT (65*1024*1024)        /* 65Mb */
#define XZ_DECODER_MEMLIMIT_STEP (25*1024*1024)   /* Increase 25Mb at a time */
#define XZ_DECODER_MEMLIMIT_FINAL (100*1024*1024) /* 100Mb */
 
struct xz_struct {
  lzma_stream stream;
  int out_index;
  uint64_t memlimit;
 
  /* liblzma bug workaround. This is what stream.avail_out should be,
     calculated correctly. Used only when reading file. */
  int out_avail;
  int total_read;
 
  FILE *plain;
  uint8_t *in_buf;  /* uint8_t is what xz headers use */
  uint8_t *out_buf;
  lzma_ret error;
 
  /* There seems to be bug in liblzma decompression that if all the
     processing happened when lzma_code() last time was called with
     LZMA_RUN action, it does not set next_out or avail_out variables
     to sane values when lzma_code() is called with LZMA_FINISH.
     We never call lzma_code() with LZMA_RUN action with all the input
     we have left. This hack_byte is kept in storage in case there is no
     more input when we try to get it. This byte can then be provided to
     lzma_code(LZMA_FINISH) */
  char hack_byte;
  bool hack_byte_used;
};
 
static bool xz_outbuffer_to_file(fz_FILE *fp, lzma_action action);
static void xz_action(fz_FILE *fp, lzma_action action);
 
#endif /* FREECIV_HAVE_LIBLZMA */
 
#ifdef FREECIV_HAVE_LIBZSTD
 
#define PLAIN_FILE_BUF_SIZE_ZSTD PLAIN_FILE_BUF_SIZE
 
struct zstd_struct {
  ZSTD_DStream *dstream;
  ZSTD_CStream *cstream;
  FILE *plain;
  int out_fd;
  ZSTD_inBuffer in_buf;
  ZSTD_outBuffer out_buf;
  char *nonconst_in;
  size_t outbuf_pos;
  size_t error;
};
 
#endif /* FREECIV_HAVE_LIBZSTD */
 
struct mem_fzFILE {
  bool control;
  char *buffer;
  int pos;
  int size;
};
 
struct fz_FILE_s {
  enum fz_method method;
  char mode;
  bool memory;
  union {
    struct mem_fzFILE mem;
    FILE *plain;                /* FZ_PLAIN */
#ifdef FREECIV_HAVE_LIBZ
    gzFile zlib;                /* FZ_ZLIB */
#endif
#ifdef FREECIV_HAVE_LIBBZ2
    struct bzip2_struct bz2;
#endif
#ifdef FREECIV_HAVE_LIBLZMA
    struct xz_struct xz;
#endif
#ifdef FREECIV_HAVE_LIBZSTD
    struct zstd_struct zstd;
#endif
  } u;
};
 
/************************************************************************/
static inline bool fz_method_is_valid(enum fz_method method)
{
  switch (method) {
  case FZ_PLAIN:
#ifdef FREECIV_HAVE_LIBZ
  case FZ_ZLIB:
#endif
#ifdef FREECIV_HAVE_LIBBZ2
  case FZ_BZIP2:
#endif
#ifdef FREECIV_HAVE_LIBLZMA
  case FZ_XZ:
#endif
#ifdef FREECIV_HAVE_LIBZSTD
  case FZ_ZSTD:
#endif
    return TRUE;
  }
  return FALSE;
}
 
#define fz_method_validate(method)                                          \
    (fz_method_is_valid(method) ? method                                    \
     : (fc_assert_msg(fz_method_is_valid(method),                           \
                      "Unsupported compress method %d, reverting to plain.",\
                      method), FZ_PLAIN))
 
 
/************************************************************************/
fz_FILE *fz_from_memory(char *buffer, int size, bool control)
{
  fz_FILE *fp;
 
  fp = (fz_FILE *)fc_malloc(sizeof(*fp));
  fp->memory = TRUE;
  fp->u.mem.control = control;
  fp->u.mem.buffer = buffer;
  fp->u.mem.pos = 0;
  fp->u.mem.size = size;
 
  return fp;
}
 
/************************************************************************/
fz_FILE *fz_from_file(const char *filename, const char *in_mode,
                      enum fz_method method, int compress_level)
{
  fz_FILE *fp;
  char mode[64];
 
  if (!is_reg_file_for_access(filename, in_mode[0] == 'w')) {
    return nullptr;
  }
 
  fp = (fz_FILE *)fc_malloc(sizeof(*fp));
  fp->memory = FALSE;
  sz_strlcpy(mode, in_mode);
 
  if (mode[0] == 'w') {
    /* Writing: */
    fp->mode = 'w';
  } else {
#if defined(FREECIV_HAVE_LIBBZ2) || defined(FREECIV_HAVE_LIBLZMA) || defined (FREECIV_HAVE_LIBZSTD)
    char test_mode[4];
 
    sz_strlcpy(test_mode, mode);
    sz_strlcat(test_mode, "b");
#endif /* FREECIV_HAVE_LIBBZ2 || FREECIV_HAVE_LIBLZMA || FREECIV_HAVE_LIBZSTD */
 
    /* Reading: ignore specified method and try each: */
    fp->mode = 'r';
 
#ifdef FREECIV_HAVE_LIBBZ2
    /* Try to open as bzip2 file
       This is simplest test, so do it first. */
    fp->u.bz2.plain = fc_fopen(filename, test_mode);
    if (fp->u.bz2.plain) {
      fp->u.bz2.file = BZ2_bzReadOpen(&fp->u.bz2.error, fp->u.bz2.plain, 1, 0,
                                      nullptr, 0);
    } else {
      /* This may currently have garbage value assigned via other union member. */
      fp->u.bz2.file = nullptr;
    }
    if (!fp->u.bz2.file) {
      if (fp->u.bz2.plain) {
        fclose(fp->u.bz2.plain);
      }
      free(fp);
      return nullptr;
    } else {
      /* Try to read first byte out of stream so we can figure out if this
         really is bzip2 file or not. Store byte for later use */
      char tmp;
      int read_len;
 
      /* We put error to tmp variable when we don't want to overwrite
       * error already in fp->u.bz2.error. So calls to fz_ferror() or
       * fz_strerror() will later return what originally went wrong,
       * and not what happened in error recovery. */
      int tmp_err;
 
      read_len = BZ2_bzRead(&fp->u.bz2.error, fp->u.bz2.file, &tmp, 1);
      if (fp->u.bz2.error != BZ_DATA_ERROR_MAGIC) {
        /* bzip2 file */
        if (fp->u.bz2.error == BZ_STREAM_END) {
          /* We already reached end of file with our read of one byte */
          if (read_len == 0) {
            /* 0 byte file */
            fp->u.bz2.firstbyte = -1;
          } else {
            fp->u.bz2.firstbyte = tmp;
          }
          fp->u.bz2.eof = TRUE;
        } else if (fp->u.bz2.error != BZ_OK) {
          /* Read failed */
          BZ2_bzReadClose(&tmp_err, fp->u.bz2.file);
          fclose(fp->u.bz2.plain);
          free(fp);
          return nullptr;
        } else {
          /* Read success and we can continue reading */
          fp->u.bz2.firstbyte = tmp;
          fp->u.bz2.eof = FALSE;
        }
        fp->method = FZ_BZIP2;
        return fp;
      }
 
      /* Not bzip2 file */
      BZ2_bzReadClose(&tmp_err, fp->u.bz2.file);
      fclose(fp->u.bz2.plain);
    }
#endif /* FREECIV_HAVE_LIBBZ2 */
 
#ifdef FREECIV_HAVE_LIBLZMA
    /* Try to open as xz file */
    fp->u.xz.memlimit = XZ_DECODER_MEMLIMIT;
    memset(&fp->u.xz.stream, 0, sizeof(lzma_stream));
    fp->u.xz.error = lzma_stream_decoder(&fp->u.xz.stream,
                                         fp->u.xz.memlimit,
                                         LZMA_CONCATENATED);
    if (fp->u.xz.error != LZMA_OK) {
      free(fp);
      return nullptr;
    }
    fp->u.xz.plain = fc_fopen(filename, test_mode);
    if (fp->u.xz.plain) {
      size_t len = 0;
 
      fp->u.xz.in_buf = fc_malloc(PLAIN_FILE_BUF_SIZE_XZ);
 
      len = fread(fp->u.xz.in_buf, 1, XZ_DECODER_TEST_SIZE,
                  fp->u.xz.plain);
      if (len > 0) {
        lzma_action action;
 
        fp->u.xz.stream.next_in = fp->u.xz.in_buf;
        fp->u.xz.stream.avail_in = len;
        fp->u.xz.out_buf = fc_malloc(PLAIN_FILE_BUF_SIZE_XZ);
        fp->u.xz.stream.next_out = fp->u.xz.out_buf;
        fp->u.xz.stream.avail_out = PLAIN_FILE_BUF_SIZE_XZ;
        len = fread(&fp->u.xz.hack_byte, 1, 1, fp->u.xz.plain);
        if (len > 0) {
          fp->u.xz.hack_byte_used = TRUE;
          action = LZMA_RUN;
        } else {
          fp->u.xz.hack_byte_used = FALSE;
          action = LZMA_FINISH;
        }
        xz_action(fp, action);
        if (fp->u.xz.error == LZMA_OK || fp->u.xz.error == LZMA_STREAM_END) {
          fp->method = FZ_XZ;
          fp->u.xz.out_index = 0;
          fp->u.xz.total_read = 0;
          fp->u.xz.out_avail = fp->u.xz.stream.total_out;
          return fp;
        }
 
        free(fp->u.xz.out_buf);
      }
      fclose(fp->u.xz.plain);
      lzma_end(&fp->u.xz.stream);
      free(fp->u.xz.in_buf);
    } else {
      free(fp);
      return nullptr;
    }
#endif /* FREECIV_HAVE_LIBLZMA */
 
#ifdef FREECIV_HAVE_LIBZSTD
    /* Try to open as zstd file */
    fp->u.zstd.dstream = ZSTD_createDStream();
 
    fp->u.zstd.plain = fc_fopen(filename, test_mode);
    if (fp->u.zstd.plain) {
      size_t len = 0;
 
      fp->u.zstd.in_buf.size = ZSTD_initDStream(fp->u.zstd.dstream);
      fp->u.zstd.nonconst_in = fc_malloc(fp->u.zstd.in_buf.size);
      fp->u.zstd.in_buf.src = fp->u.zstd.nonconst_in;
 
      len = fread(fp->u.zstd.nonconst_in, 1, fp->u.zstd.in_buf.size,
                  fp->u.zstd.plain);
      if (len > 0) {
        if (len < fp->u.zstd.in_buf.size) {
          fp->u.zstd.in_buf.size = len;
        }
        fp->u.zstd.out_buf.size = ZSTD_DStreamOutSize();
        fp->u.zstd.out_buf.dst = fc_malloc(fp->u.zstd.out_buf.size);
 
        fp->u.zstd.out_buf.pos = 0;
        fp->u.zstd.in_buf.pos = 0;
 
        fp->u.zstd.error = ZSTD_decompressStream(fp->u.zstd.dstream,
                                                 &fp->u.zstd.out_buf,
                                                 &fp->u.zstd.in_buf);
 
        if (!ZSTD_isError(fp->u.zstd.error)) {
          fp->method = FZ_ZSTD;
          fp->u.zstd.outbuf_pos = 0;
          return fp;
        }
 
        free(fp->u.zstd.out_buf.dst);
      }
 
      free(fp->u.zstd.nonconst_in);
      fclose(fp->u.zstd.plain);
    }
 
    ZSTD_freeDStream(fp->u.zstd.dstream);
#endif /* FREECIV_HAVE_LIBZSTD */
 
#ifdef FREECIV_HAVE_LIBZ
    method = FZ_ZLIB;
#else
    method = FZ_PLAIN;
#endif
  }
 
  fp->method = fz_method_validate(method);
 
  switch (fp->method) {
#ifdef FREECIV_HAVE_LIBLZMA
  case FZ_XZ:
    {
      lzma_ret ret;
 
      /* xz files are binary files, so we should add "b" to mode! */
      sz_strlcat(mode, "b");
      memset(&fp->u.xz.stream, 0, sizeof(lzma_stream));
      ret = lzma_easy_encoder(&fp->u.xz.stream, compress_level, LZMA_CHECK_CRC32);
      fp->u.xz.error = ret;
      if (ret != LZMA_OK) {
        free(fp);
        return nullptr;
      }
      fp->u.xz.in_buf = fc_malloc(PLAIN_FILE_BUF_SIZE_XZ);
      fp->u.xz.stream.next_in = fp->u.xz.in_buf;
      fp->u.xz.out_buf = fc_malloc(PLAIN_FILE_BUF_SIZE_XZ);
      fp->u.xz.stream.next_out = fp->u.xz.out_buf;
      fp->u.xz.stream.avail_out = PLAIN_FILE_BUF_SIZE_XZ;
      fp->u.xz.out_index = 0;
      fp->u.xz.total_read = 0;
      fp->u.xz.plain = fc_fopen(filename, mode);
      if (!fp->u.xz.plain) {
        free(fp);
        return nullptr;
      }
    }
    return fp;
#endif /* FREECIV_HAVE_LIBLZMA */
#ifdef FREECIV_HAVE_LIBZSTD
  case FZ_ZSTD:
    {
      /* zstd files are binary files, so we should add "b" to mode! */
      sz_strlcat(mode, "b");
 
      fp->u.zstd.plain = fc_fopen(filename, mode);
      if (!fp->u.zstd.plain) {
        free(fp);
        return nullptr;
      }
 
      fp->u.zstd.cstream = ZSTD_createCStream();
 
      /* As compress_level parameter is in range 0 - 9, and zstd takes 0 - 22,
       * we scale it a bit */
      ZSTD_initCStream(fp->u.zstd.cstream, compress_level * 2);
 
      fp->u.zstd.in_buf.size = PLAIN_FILE_BUF_SIZE_ZSTD;
      fp->u.zstd.nonconst_in = fc_malloc(fp->u.zstd.in_buf.size);
      fp->u.zstd.in_buf.src = fp->u.zstd.nonconst_in;
      fp->u.zstd.out_buf.size = ZSTD_CStreamOutSize();
      fp->u.zstd.out_buf.dst = fc_malloc(fp->u.zstd.out_buf.size);
      fp->u.zstd.in_buf.pos = 0;
      fp->u.zstd.out_buf.pos = 0;
    }
    return fp;
#endif /* FREECIV_HAVE_LIBZSTD */
#ifdef FREECIV_HAVE_LIBBZ2
  case FZ_BZIP2:
    /*  bz2 files are binary files, so we should add "b" to mode! */
    sz_strlcat(mode, "b");
    fp->u.bz2.plain = fc_fopen(filename, mode);
    if (fp->u.bz2.plain) {
      /*  Open for read handled earlier */
      fc_assert_ret_val('w' == mode[0], nullptr);
      fp->u.bz2.file = BZ2_bzWriteOpen(&fp->u.bz2.error, fp->u.bz2.plain,
                                       compress_level, 1, 15);
      if (fp->u.bz2.error != BZ_OK) {
        int tmp_err; /* See comments for similar variable
                      * near BZ2_bzReadOpen() */
 
        BZ2_bzWriteClose(&tmp_err, fp->u.bz2.file, 0, nullptr, nullptr);
        fp->u.bz2.file = nullptr;
      }
    } else {
      fp->u.bz2.file = nullptr;
    }
    if (!fp->u.bz2.file) {
      if (fp->u.bz2.plain) {
        fclose(fp->u.bz2.plain);
      }
      free(fp);
      fp = nullptr;
    }
    return fp;
#endif /* FREECIV_HAVE_LIBBZ2 */
#ifdef FREECIV_HAVE_LIBZ
  case FZ_ZLIB:
    /* gz files are binary files, so we should add "b" to mode! */
    sz_strlcat(mode, "b");
    if (mode[0] == 'w') {
      cat_snprintf(mode, sizeof(mode), "%d", compress_level);
    }
    fp->u.zlib = fc_gzopen(filename, mode);
    if (!fp->u.zlib) {
      free(fp);
      fp = nullptr;
    }
    return fp;
#endif /* FREECIV_HAVE_LIBZ */
  case FZ_PLAIN:
    fp->u.plain = fc_fopen(filename, mode);
    if (!fp->u.plain) {
      free(fp);
      fp = nullptr;
    }
    return fp;
  }
 
  /* Should never happen */
  fc_assert_msg(FALSE, "Internal error in %s() (method = %d)",
                __FUNCTION__, fp->method);
  free(fp);
  return nullptr;
}
 
/************************************************************************/
fz_FILE *fz_from_stream(FILE *stream)
{
  fz_FILE *fp;
 
  if (!stream) {
    return nullptr;
  }
 
  fp = fc_malloc(sizeof(*fp));
  fp->method = FZ_PLAIN;
  fp->memory = FALSE;
  fp->u.plain = stream;
  return fp;
}
 
/************************************************************************/
int fz_fclose(fz_FILE *fp)
{
  int error = 0;
 
  fc_assert_ret_val(fp != nullptr, 1);
 
  if (fp->memory) {
    if (fp->u.mem.control) {
      FC_FREE(fp->u.mem.buffer);
    }
    FC_FREE(fp);
 
    return 0;
  }
 
  switch (fz_method_validate(fp->method)) {
#ifdef FREECIV_HAVE_LIBLZMA
  case FZ_XZ:
    if (fp->mode == 'w' && !xz_outbuffer_to_file(fp, LZMA_FINISH)) {
      error = 1;
    }
    lzma_end(&fp->u.xz.stream);
    free(fp->u.xz.in_buf);
    free(fp->u.xz.out_buf);
    fclose(fp->u.xz.plain);
    free(fp);
    return error;
#endif /* FREECIV_HAVE_LIBLZMA */
#ifdef FREECIV_HAVE_LIBZSTD
  case FZ_ZSTD:
    if (fp->mode == 'w') {
      fp->u.zstd.error = ZSTD_endStream(fp->u.zstd.cstream, &fp->u.zstd.out_buf);
      while (fp->u.zstd.out_buf.pos > 0) {
        fwrite(fp->u.zstd.out_buf.dst, 1,
               fp->u.zstd.out_buf.pos, fp->u.zstd.plain);
        fp->u.zstd.out_buf.pos = 0;
        fp->u.zstd.error = ZSTD_flushStream(fp->u.zstd.cstream, &fp->u.zstd.out_buf);
      }
      ZSTD_freeCStream(fp->u.zstd.cstream);
    } else {
      ZSTD_freeDStream(fp->u.zstd.dstream);
    }
    free(fp->u.zstd.nonconst_in);
    free(fp->u.zstd.out_buf.dst);
    fclose(fp->u.zstd.plain);
    free(fp);
    return 0;
#endif /* FREECIV_HAVE_LIBZSTD */
#ifdef FREECIV_HAVE_LIBBZ2
  case FZ_BZIP2:
    if ('w' == fp->mode) {
      BZ2_bzWriteClose(&fp->u.bz2.error, fp->u.bz2.file, 0, nullptr, nullptr);
    } else {
      BZ2_bzReadClose(&fp->u.bz2.error, fp->u.bz2.file);
    }
    error = fp->u.bz2.error;
    fclose(fp->u.bz2.plain);
    free(fp);
    return BZ_OK == error ? 0 : 1;
#endif /* FREECIV_HAVE_LIBBZ2 */
#ifdef FREECIV_HAVE_LIBZ
  case FZ_ZLIB:
    error = gzclose(fp->u.zlib);
    free(fp);
    return 0 > error ? error : 0; /* Only negative Z values are errors. */
#endif /* FREECIV_HAVE_LIBZ */
  case FZ_PLAIN:
    error = fclose(fp->u.plain);
    free(fp);
    return error;
  }
 
  /* Should never happen */
  fc_assert_msg(FALSE, "Internal error in %s() (method = %d)",
                __FUNCTION__, fp->method);
  free(fp);
  return 1;
}
 
/************************************************************************/
char *fz_fgets(char *buffer, int size, fz_FILE *fp)
{
  fc_assert_ret_val(fp != nullptr, nullptr);
 
  if (fp->memory) {
    int i, j;
 
    for (i = fp->u.mem.pos, j = 0;
         i < fp->u.mem.size && j < size - 1 /* Space for '\0' */
           && fp->u.mem.buffer[i] != '\n'
           && (fp->u.mem.buffer[i] != '\r'
               || fp->u.mem.size == i + 1
               || fp->u.mem.buffer[i + 1] != '\n'); i++) {
      buffer[j++] = fp->u.mem.buffer[i];
    }
 
    if (j < size - 2) {
      /* Space for both newline and terminating '\0' */
      if (i + 1 < fp->u.mem.size
          && fp->u.mem.buffer[i] == '\r'
          && fp->u.mem.buffer[i + 1] == '\n') {
        i += 2;
        buffer[j++] = '\n';
      } else if (i < fp->u.mem.size
                 && fp->u.mem.buffer[i] == '\n') {
        i++;
        buffer[j++] = '\n';
      }
    }
 
    if (j == 0) {
      return nullptr;
    }
 
    fp->u.mem.pos = i;
    buffer[j] = '\0';
 
    return buffer;
  }
 
  switch (fz_method_validate(fp->method)) {
#ifdef FREECIV_HAVE_LIBLZMA
  case FZ_XZ:
    {
      int i, j;
 
      for (i = 0; i < size - 1; i += j) {
        size_t len = 0;
        bool line_end;
 
        for (j = 0, line_end = FALSE; fp->u.xz.out_avail > 0
               && !line_end
               && j < size - i - 1;
             j++, fp->u.xz.out_avail--) {
          buffer[i + j] = fp->u.xz.out_buf[fp->u.xz.out_index++];
          fp->u.xz.total_read++;
          if (buffer[i + j] == '\n') {
            line_end = TRUE;
          }
        }
 
        if (line_end || size <= j + i + 1) {
          buffer[i + j] = '\0';
          return buffer;
        }
 
        if (fp->u.xz.hack_byte_used) {
          size_t hblen = 0;
 
          fp->u.xz.in_buf[0] = fp->u.xz.hack_byte;
          len = fread(fp->u.xz.in_buf + 1, 1, PLAIN_FILE_BUF_SIZE_XZ - 1,
                      fp->u.xz.plain);
          len++;
 
          if (len <= 1) {
            hblen = fread(&fp->u.xz.hack_byte, 1, 1, fp->u.xz.plain);
          }
          if (hblen == 0) {
            fp->u.xz.hack_byte_used = FALSE;
          }
        }
        if (len == 0) {
          if (fp->u.xz.error == LZMA_STREAM_END) {
            if (i + j == 0) {
              /* Plain file read complete, and there was nothing in xz buffers
                 -> end-of-file. */
              return nullptr;
            }
            buffer[i + j] = '\0';
            return buffer;
          } else {
            fp->u.xz.stream.next_out = fp->u.xz.out_buf;
            fp->u.xz.stream.avail_out = PLAIN_FILE_BUF_SIZE_XZ;
            xz_action(fp, LZMA_FINISH);
            fp->u.xz.out_index = 0;
            fp->u.xz.out_avail =
              fp->u.xz.stream.total_out - fp->u.xz.total_read;
            if (fp->u.xz.error != LZMA_OK
                && fp->u.xz.error != LZMA_STREAM_END) {
              return nullptr;
            }
          }
        } else {
          lzma_action action;
 
          fp->u.xz.stream.next_in = fp->u.xz.in_buf;
          fp->u.xz.stream.avail_in = len;
          fp->u.xz.stream.next_out = fp->u.xz.out_buf;
          fp->u.xz.stream.avail_out = PLAIN_FILE_BUF_SIZE_XZ;
          if (fp->u.xz.hack_byte_used) {
            action = LZMA_RUN;
          } else {
            action = LZMA_FINISH;
          }
          xz_action(fp, action);
          fp->u.xz.out_avail =
            fp->u.xz.stream.total_out - fp->u.xz.total_read;
          fp->u.xz.out_index = 0;
          if (fp->u.xz.error != LZMA_OK && fp->u.xz.error != LZMA_STREAM_END) {
            return nullptr;
          }
        }
      }
 
      buffer[i] = '\0';
      return buffer;
    }
    break;
#endif /* FREECIV_HAVE_LIBLZMA */
#ifdef FREECIV_HAVE_LIBZSTD
  case FZ_ZSTD:
    {
      int i;
 
      for (i = 0; i < size - 1;) {
        int j;
        size_t len = 0;
 
        while (fp->u.zstd.outbuf_pos < fp->u.zstd.out_buf.pos) {
          buffer[i] = ((char *)fp->u.zstd.out_buf.dst)[fp->u.zstd.outbuf_pos++];
          if (buffer[i] == '\n' || i == size - 2) {
            buffer[i + 1] = '\0';
            return buffer;
          }
 
          i++;
        }
 
        fp->u.zstd.outbuf_pos = 0;
 
        if (fp->u.zstd.in_buf.pos != 0) {
          /* Move in-buffer */
          for (j = 0; j < fp->u.zstd.in_buf.size - fp->u.zstd.in_buf.pos; j++) {
            fp->u.zstd.nonconst_in[j] = fp->u.zstd.nonconst_in[j + fp->u.zstd.in_buf.pos];
          }
 
          /* Fill in-buffer from plain file */
          len = fread(fp->u.zstd.nonconst_in + j, 1, fp->u.zstd.in_buf.size - j,
                      fp->u.zstd.plain);
 
          if (len + j < fp->u.zstd.in_buf.size) {
            fp->u.zstd.in_buf.size = len + j;
          }
        }
 
        fp->u.zstd.out_buf.pos = 0;
        fp->u.zstd.in_buf.pos = 0;
 
        fp->u.zstd.error = ZSTD_decompressStream(fp->u.zstd.dstream,
                                                 &fp->u.zstd.out_buf,
                                                 &fp->u.zstd.in_buf);
        if (ZSTD_isError(fp->u.zstd.error)) {
          /* zstd error */
          return nullptr;
        }
 
        if (fp->u.zstd.out_buf.pos == 0 && len == 0) {
          /* Plain file fully read, and decompression outbuffer drained. */
          if (i == 0) {
            return nullptr;
          }
 
          buffer[i] = '\0';
          return buffer;
        }
      }
 
      buffer[i] = '\0';
      return buffer;
    }
    break;
#endif /* FREECIV_HAVE_LIBZSTD */
#ifdef FREECIV_HAVE_LIBBZ2
  case FZ_BZIP2:
    {
      char *retval = nullptr;
      int i = 0;
      int last_read;
 
      /* See if first byte is already read and stored */
      if (fp->u.bz2.firstbyte >= 0) {
        buffer[0] = fp->u.bz2.firstbyte;
        fp->u.bz2.firstbyte = -1;
        i++;
      } else {
        if (!fp->u.bz2.eof) {
          last_read = BZ2_bzRead(&fp->u.bz2.error, fp->u.bz2.file, buffer + i, 1);
          i += last_read; /* 0 or 1 */
        }
      }
      if (!fp->u.bz2.eof) {
        /* Leave space for trailing zero */
        for (; i < size - 1
               && fp->u.bz2.error == BZ_OK && buffer[i - 1] != '\n' ;
             i += last_read) {
          last_read = BZ2_bzRead(&fp->u.bz2.error, fp->u.bz2.file,
                                 buffer + i, 1);
        }
        if (fp->u.bz2.error != BZ_OK
            && (fp->u.bz2.error != BZ_STREAM_END
                || i == 0)) {
          retval = nullptr;
        } else {
          retval = buffer;
        }
        if (fp->u.bz2.error == BZ_STREAM_END) {
          /* EOF reached. Do not BZ2_bzRead() any more. */
          fp->u.bz2.eof = TRUE;
        }
      }
      buffer[i] = '\0';
      return retval;
    }
#endif /* FREECIV_HAVE_LIBBZ2 */
#ifdef FREECIV_HAVE_LIBZ
  case FZ_ZLIB:
    return gzgets(fp->u.zlib, buffer, size);
#endif /* FREECIV_HAVE_LIBZ */
  case FZ_PLAIN:
    return fgets(buffer, size, fp->u.plain);
  }
 
  /* Should never happen */
  fc_assert_msg(FALSE, "Internal error in %s() (method = %d)",
                __FUNCTION__, fp->method);
  return nullptr;
}
 
#ifdef FREECIV_HAVE_LIBLZMA
 
/************************************************************************/
static bool xz_outbuffer_to_file(fz_FILE *fp, lzma_action action)
{
  do {
    size_t len;
    size_t total = 0;
 
    fp->u.xz.error = lzma_code(&fp->u.xz.stream, action);
 
    if (fp->u.xz.error != LZMA_OK && fp->u.xz.error != LZMA_STREAM_END) {
      return FALSE;
    }
 
    while (total < PLAIN_FILE_BUF_SIZE_XZ - fp->u.xz.stream.avail_out) {
      len = fwrite(fp->u.xz.out_buf, 1,
                   PLAIN_FILE_BUF_SIZE_XZ - fp->u.xz.stream.avail_out - total,
                   fp->u.xz.plain);
      total += len;
      if (len == 0) {
        return FALSE;
      }
    }
    fp->u.xz.stream.avail_out = PLAIN_FILE_BUF_SIZE_XZ;
    fp->u.xz.stream.next_out = fp->u.xz.out_buf;
  } while (fp->u.xz.stream.avail_in > 0);
 
  return TRUE;
}
 
/************************************************************************/
static void xz_action(fz_FILE *fp, lzma_action action)
{
  fp->u.xz.error = lzma_code(&fp->u.xz.stream, action);
  if (fp->u.xz.error != LZMA_MEMLIMIT_ERROR) {
    return;
  }
 
  while (fp->u.xz.error == LZMA_MEMLIMIT_ERROR
         && fp->u.xz.memlimit < XZ_DECODER_MEMLIMIT_FINAL) {
    fp->u.xz.memlimit += XZ_DECODER_MEMLIMIT_STEP;
    if (fp->u.xz.memlimit > XZ_DECODER_MEMLIMIT_FINAL) {
      fp->u.xz.memlimit = XZ_DECODER_MEMLIMIT_FINAL;
    }
    fp->u.xz.error = lzma_memlimit_set(&fp->u.xz.stream, fp->u.xz.memlimit);
  }
 
  fp->u.xz.error = lzma_code(&fp->u.xz.stream, action);
}
#endif /* FREECIV_HAVE_LIBLZMA */
 
/************************************************************************/
int fz_fprintf(fz_FILE *fp, const char *format, ...)
{
  int num;
  va_list ap;
 
  fc_assert_ret_val(fp != nullptr, 0);
  fc_assert_ret_val(!fp->memory, 0);
 
  switch (fz_method_validate(fp->method)) {
#ifdef FREECIV_HAVE_LIBLZMA
  case FZ_XZ:
    {
      va_start(ap, format);
      num = fc_vsnprintf((char *)fp->u.xz.in_buf, PLAIN_FILE_BUF_SIZE_XZ,
                         format, ap);
      va_end(ap);
 
      if (num == -1) {
        log_error("Too much data: truncated in fz_fprintf (%u)",
                  PLAIN_FILE_BUF_SIZE_XZ);
        num = PLAIN_FILE_BUF_SIZE_XZ;
      }
      fp->u.xz.stream.next_in = fp->u.xz.in_buf;
      fp->u.xz.stream.avail_in = num;
 
      if (!xz_outbuffer_to_file(fp, LZMA_RUN)) {
        return 0;
      } else {
        return strlen((char *)fp->u.xz.in_buf);
      }
    }
    break;
#endif /* FREECIV_HAVE_LIBLZMA */
#ifdef FREECIV_HAVE_LIBZSTD
  case FZ_ZSTD:
    {
      va_start(ap, format);
      num = fc_vsnprintf((char *)fp->u.zstd.in_buf.src,
                         PLAIN_FILE_BUF_SIZE_ZSTD, format, ap);
      va_end(ap);
 
      if (num == -1) {
        log_error("Too much data: truncated in fz_fprintf (%u)",
                  PLAIN_FILE_BUF_SIZE_ZSTD);
        num = PLAIN_FILE_BUF_SIZE_ZSTD;
      }
 
      fp->u.zstd.in_buf.pos = 0;
      fp->u.zstd.in_buf.size = num;
 
      while (fp->u.zstd.in_buf.pos < fp->u.zstd.in_buf.size) {
        int len;
 
        fp->u.zstd.error = ZSTD_compressStream(fp->u.zstd.cstream,
                                               &fp->u.zstd.out_buf,
                                               &fp->u.zstd.in_buf);
        if (ZSTD_isError(fp->u.zstd.error)) {
          return 0;
        }
 
        if (fp->u.zstd.out_buf.pos > 0) {
          len = fwrite(fp->u.zstd.out_buf.dst, 1,
                       fp->u.zstd.out_buf.pos, fp->u.zstd.plain);
 
          if (len < 0) {
            return 0;
          }
 
          fp->u.zstd.out_buf.pos = 0;
        }
      }
 
      return num;
    }
    break;
#endif /* FREECIV_HAVE_LIBZSTD */
#ifdef FREECIV_HAVE_LIBBZ2
  case FZ_BZIP2:
    {
      char buffer[65536];
 
      va_start(ap, format);
      num = fc_vsnprintf(buffer, sizeof(buffer), format, ap);
      va_end(ap);
      if (num == -1) {
        log_error("Too much data: truncated in fz_fprintf (%lu)",
                  (unsigned long) sizeof(buffer));
      }
      BZ2_bzWrite(&fp->u.bz2.error, fp->u.bz2.file, buffer, strlen(buffer));
      if (fp->u.bz2.error != BZ_OK) {
        return 0;
      } else {
        return strlen(buffer);
      }
    }
#endif /* FREECIV_HAVE_LIBBZ2 */
#ifdef FREECIV_HAVE_LIBZ
  case FZ_ZLIB:
    {
      char buffer[65536];
 
      va_start(ap, format);
      num = fc_vsnprintf(buffer, sizeof(buffer), format, ap);
      va_end(ap);
      if (num == -1) {
        log_error("Too much data: truncated in fz_fprintf (%lu)",
                  (unsigned long) sizeof(buffer));
      }
      return gzwrite(fp->u.zlib, buffer, (unsigned int)strlen(buffer));
    }
#endif /* FREECIV_HAVE_LIBZ */
  case FZ_PLAIN:
    va_start(ap, format);
    num = vfprintf(fp->u.plain, format, ap);
    va_end(ap);
    return num;
  }
 
  /* Should never happen */
  fc_assert_msg(FALSE, "Internal error in %s() (method = %d)",
                __FUNCTION__, fp->method);
  return 0;
}
 
/************************************************************************/
int fz_ferror(fz_FILE *fp)
{
  fc_assert_ret_val(fp != nullptr, 0);
 
  if (fp->memory) {
    return 0;
  }
 
  switch (fz_method_validate(fp->method)) {
#ifdef FREECIV_HAVE_LIBLZMA
  case FZ_XZ:
    if (fp->u.xz.error != LZMA_OK
        && fp->u.xz.error != LZMA_STREAM_END) {
      return 1;
    }
 
    return 0;
#endif /* FREECIV_HAVE_LZMA */
#ifdef FREECIV_HAVE_LIBZSTD
  case FZ_ZSTD:
    if (ZSTD_isError(fp->u.zstd.error)) {
      return 1;
    }
    return 0;
#endif /* FREECIV_HAVE_LIBZSTD */
#ifdef FREECIV_HAVE_LIBBZ2
  case FZ_BZIP2:
    return (BZ_OK != fp->u.bz2.error
            && BZ_STREAM_END != fp->u.bz2.error);
#endif /* FREECIV_HAVE_LIBBZ2 */
#ifdef FREECIV_HAVE_LIBZ
  case FZ_ZLIB:
    {
      int error;
 
      (void) gzerror(fp->u.zlib, &error); /* Ignore string result here. */
      return 0 > error ? error : 0; /* Only negative Z values are errors. */
    }
#endif /* FREECIV_HAVE_LIBZ */
  case FZ_PLAIN:
    return ferror(fp->u.plain);
    break;
  }
 
  /* Should never happen */
  fc_assert_msg(FALSE, "Internal error in %s() (method = %d)",
                __FUNCTION__, fp->method);
  return 0;
}
 
/************************************************************************/
const char *fz_strerror(fz_FILE *fp)
{
  fc_assert_ret_val(fp != nullptr, nullptr);
  fc_assert_ret_val(!fp->memory, nullptr);
 
  switch (fz_method_validate(fp->method)) {
#ifdef FREECIV_HAVE_LIBLZMA
  case FZ_XZ:
    {
      static char xzerror[50];
      char *cleartext = nullptr;
 
      switch (fp->u.xz.error) {
       case LZMA_OK:
         cleartext = "OK";
         break;
       case LZMA_STREAM_END:
         cleartext = "Stream end";
         break;
       case LZMA_NO_CHECK:
         cleartext = "No integrity check";
         break;
       case LZMA_UNSUPPORTED_CHECK:
         cleartext = "Cannot calculate the integrity check";
         break;
       case LZMA_MEM_ERROR:
         cleartext = "Mem error";
         break;
       case LZMA_MEMLIMIT_ERROR:
         cleartext = "Memory limit reached";
         break;
       case LZMA_FORMAT_ERROR:
         cleartext = "Unrecognized file format";
         break;
       case LZMA_OPTIONS_ERROR:
         cleartext = "Unsupported options";
         break;
       case LZMA_DATA_ERROR:
         cleartext = "Data error";
         break;
       case LZMA_BUF_ERROR:
         cleartext = "Progress not possible";
         break;
       default:
         break;
      }
 
      if (cleartext != nullptr) {
        fc_snprintf(xzerror, sizeof(xzerror), "XZ: \"%s\" (%d)",
                    cleartext, fp->u.xz.error);
      } else {
        fc_snprintf(xzerror, sizeof(xzerror), "XZ error %d",
                    fp->u.xz.error);
      }
      return xzerror;
    }
    break;
#endif /* FREECIV_HAVE_LIBLZMA */
#ifdef FREECIV_HAVE_LIBZSTD
  case FZ_ZSTD:
    {
      static char zstderror[50];
      char *cleartext = nullptr;
 
      if (ZSTD_isError(fp->u.zstd.error)) {
        cleartext = "error";
      }
 
      if (cleartext != nullptr) {
        fc_snprintf(zstderror, sizeof(zstderror),
                    "ZSTD: \"%s\" (" SIZE_T_PRINTF ")",
                    cleartext, fp->u.zstd.error);
      } else {
        fc_snprintf(zstderror, sizeof(zstderror),
                    "ZSTD error " SIZE_T_PRINTF,
                    fp->u.zstd.error);
      }
      return zstderror;
    }
    break;
#endif /* FREECIV_HAVE_LIBZSTD */
#ifdef FREECIV_HAVE_LIBBZ2
  case FZ_BZIP2:
    {
      static char bzip2error[50];
      const char *cleartext = nullptr;
 
      /* Rationale for translating these:
       * - Some of them provide usable information to user
       * - Messages still contain numerical error code for developers
       */
      switch (fp->u.bz2.error) {
       case BZ_OK:
         cleartext = "OK";
         break;
       case BZ_RUN_OK:
         cleartext = "Run ok";
         break;
       case BZ_FLUSH_OK:
         cleartext = "Flush ok";
         break;
       case BZ_FINISH_OK:
         cleartext = "Finish ok";
         break;
       case BZ_STREAM_END:
         cleartext = "Stream end";
         break;
       case BZ_CONFIG_ERROR:
         cleartext = "Config error";
         break;
       case BZ_SEQUENCE_ERROR:
         cleartext = "Sequence error";
         break;
       case BZ_PARAM_ERROR:
         cleartext = "Parameter error";
         break;
       case BZ_MEM_ERROR:
         cleartext = "Mem error";
         break;
       case BZ_DATA_ERROR:
         cleartext = "Data error";
         break;
       case BZ_DATA_ERROR_MAGIC:
         cleartext = "Not bzip2 file";
         break;
       case BZ_IO_ERROR:
         cleartext = "IO error";
         break;
       case BZ_UNEXPECTED_EOF:
         cleartext = "Unexpected EOF";
         break;
       case BZ_OUTBUFF_FULL:
         cleartext = "Output buffer full";
         break;
       default:
         break;
      }
 
      if (cleartext != nullptr) {
        fc_snprintf(bzip2error, sizeof(bzip2error), "Bz2: \"%s\" (%d)",
                    cleartext, fp->u.bz2.error);
      } else {
        fc_snprintf(bzip2error, sizeof(bzip2error), "Bz2 error %d",
                    fp->u.bz2.error);
      }
      return bzip2error;
    }
#endif /* FREECIV_HAVE_LIBBZ2 */
#ifdef FREECIV_HAVE_LIBZ
  case FZ_ZLIB:
    {
      int errnum;
      const char *estr = gzerror(fp->u.zlib, &errnum);
 
      return Z_ERRNO == errnum ? fc_strerror(fc_get_errno()) : estr;
    }
#endif /* FREECIV_HAVE_LIBZ */
  case FZ_PLAIN:
    return fc_strerror(fc_get_errno());
  }
 
  /* Should never happen */
  fc_assert_msg(FALSE, "Internal error in %s() (method = %d)",
                __FUNCTION__, fp->method);
  return nullptr;
}