xref: /dports/math/gretl/gretl-2021d/lib/src/gretl_zip.c

/*
 *  gretl -- Gnu Regression, Econometrics and Time-series Library
 *  Copyright (C) 2001 Allin Cottrell and Riccardo "Jack" Lucchetti
 *
 *  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 3 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include "libgretl.h"
#include "gretl_zip.h"

static int handle_zip_error (const char *fname,
			     GError *gerr, int err,
			     const char *action)
{
    if (gerr != NULL) {
	fprintf(stderr, "handle_zip_error: '%s'\n", gerr->message);
	gretl_errmsg_sprintf("%s: %s", fname, gerr->message);
	g_error_free(gerr);
    } else if (err) {
	gretl_errmsg_sprintf("%s: error %s", fname, action);
    }

    return err;
}

#ifdef USE_GSF /* libgsf-1 >= 1.14.31 */

#include <gsf/gsf.h>

#define ZDEBUG 0
#define CHUNK 32768

#define gsf_is_dir(i) (GSF_IS_INFILE(i) && \
		       gsf_infile_num_children(GSF_INFILE(i)) >= 0)

static void ensure_gsf_init (void)
{
    static int initted;

    if (!initted) {
	gsf_init();
	initted = 1;
    }
}

static int transcribe_gsf_data (GsfInput *input, GsfOutput *output)
{
    guint8 const *data;
    size_t len;

    while ((len = gsf_input_remaining(input)) > 0) {
	if (len > CHUNK) {
	    len = CHUNK;
	}
	if ((data = gsf_input_read(input, len, NULL)) == NULL) {
	    return 1;
	}
	if (!gsf_output_write(output, len, data)) {
	    return 1;
	}
    }

    return 0;
}

static int clone_gsf_tree (GsfInput *input, GsfOutput *output)
{
    int err = 0;

    if (gsf_input_size(input) > 0) {
	err = transcribe_gsf_data(input, output);
    }

    if (GSF_IS_INFILE(input) && gsf_infile_num_children(GSF_INFILE(input)) > 0) {
	GsfInfile *in = GSF_INFILE(input);
	GsfOutfile *out = GSF_OUTFILE(output);
	int i, n = gsf_infile_num_children(in);
	char const *name;
	GsfInput *src;
	GsfOutput *dest;
	gboolean is_dir;
	GDateTime *modtime;

	for (i=0; i<n && !err; i++) {
	    src = gsf_infile_child_by_index(in, i);
	    if (src == NULL) {
		err = 1;
		break;
	    }

	    name = gsf_infile_name_by_index(in, i);
	    is_dir = gsf_is_dir(src);
#if ZDEBUG
	    fprintf(stderr, "clone_gsf_tree: i = %d (%s, %s)\n", i, name,
		    is_dir ? "directory" : "file");
#endif
	    modtime = gsf_input_get_modtime(src);
	    dest = gsf_outfile_new_child_full(out, name, is_dir,
					      "modtime", modtime,
					      NULL);
	    if (dest == NULL) {
		err = 1;
	    } else {
		err = clone_gsf_tree(src, dest);
	    }
	}
    }

    gsf_output_close(output);
    g_object_unref(G_OBJECT(output));
    g_object_unref(G_OBJECT(input));

    return err;
}

static int gretl_gsf_make_zipfile (const char *fname,
				   const char *path)
{
    GsfInfile *infile;
    GsfOutput *output, *ziproot;
    GsfOutfile *outfile = NULL;
    GError *gerr = NULL;
    int err = 0;

    ensure_gsf_init();

#if ZDEBUG
    fprintf(stderr, "gretl_make_zipfile (gsf):\n fname='%s'\n path='%s'\n",
	    fname, path);
#endif

    infile = gsf_infile_stdio_new(path, &gerr);

    if (infile == NULL) {
	err = 1;
    } else {
	output = gsf_output_stdio_new(fname, &gerr);
	if (output == NULL) {
	    err = 1;
	}
    }

    if (!err) {
	outfile = gsf_outfile_zip_new(output, &gerr);
	g_object_unref(G_OBJECT(output));
	if (outfile == NULL) {
	    err = 1;
	}
    }

    if (!err) {
	ziproot = gsf_outfile_new_child(outfile, path, 1);
	if (ziproot == NULL) {
	    fprintf(stderr, "failed to create ziproot for '%s'\n", path);
	    err = 1;
	} else {
	    err = clone_gsf_tree(GSF_INPUT(infile), ziproot);
	}
    }

    if (outfile != NULL) {
	gsf_output_close(GSF_OUTPUT(outfile));
	g_object_unref(G_OBJECT(outfile));
    }

#if ZDEBUG
    fprintf(stderr, "*** gretl_make_zipfile: returning %d\n", err);
#endif

    return handle_zip_error(fname, gerr, err, "zipping");
}

static int gretl_gsf_zip_datafile (const char *fname,
				   const char *path,
				   int level)
{
    GsfOutput *output;
    GsfOutfile *outfile = NULL;
    GError *gerr = NULL;
    int err = 0;

    ensure_gsf_init();

#if ZDEBUG
    fprintf(stderr, "gretl_zip_datafile (gsf):\n fname='%s'\n", fname);
#endif

    output = gsf_output_stdio_new(fname, &gerr);
    if (output == NULL) {
	err = 1;
    }

    if (!err) {
	outfile = gsf_outfile_zip_new(output, &gerr);
	g_object_unref(G_OBJECT(output));
	if (outfile == NULL) {
	    err = 1;
	}
    }

    if (!err) {
	const char *names[] = { "data.xml", "data.bin" };
	char fullname[FILENAME_MAX];
	GsfInput *zinp;
	GsfOutput *zout;
	int i;

	for (i=0; i<2 && !err; i++) {
	    gretl_build_path(fullname, path, names[i], NULL);
	    zinp = gsf_input_stdio_new(fullname, &gerr);
	    if (zinp == NULL) {
		err = 1;
	    } else {
		/* note: property not present in libgsf <= 1.14.30 */
		zout = gsf_outfile_new_child_full(outfile, names[i], 0,
						  "deflate-level", level,
						  NULL);
		err = transcribe_gsf_data(zinp, zout);
		gsf_output_close(zout);
		g_object_unref(G_OBJECT(zout));
		g_object_unref(G_OBJECT(zinp));
	    }
	}
    }

    if (outfile != NULL) {
	gsf_output_close(GSF_OUTPUT(outfile));
	g_object_unref(G_OBJECT(outfile));
    }

#if ZDEBUG
    fprintf(stderr, "*** gretl_gsf_zip_datafile: returning %d\n", err);
#endif

    return handle_zip_error(fname, gerr, err, "zipping");
}

/* @fname: the name of the file to be unzipped.
   @path: if non-NULL, the location into which the unzipping
   should be done (if NULL, use pwd).
   @zdirname: if non-NULL, set its content to the name of
   the top-level directory within the zipfile (via g_strdup).
*/

static int gretl_gsf_unzip (const char *fname,
			    const char *path,
			    gchar **zdirname)
{
    GsfInput *input;
    GsfInfile *infile;
    GsfOutfile *outfile;
    GError *gerr = NULL;
    int err = 0;

#if ZDEBUG
    fprintf(stderr, "*** gretl_gsf_unzip_file:\n fname='%s'\n", fname);
    fprintf(stderr, "path='%s', zdirname=%p\n", path, (void *) zdirname);
#endif

    ensure_gsf_init();
    input = gsf_input_stdio_new(fname, &gerr);

    if (input == NULL) {
	err = 1;
    } else {
	infile = gsf_infile_zip_new(input, &gerr);
	g_object_unref(G_OBJECT(input));
	if (infile == NULL) {
	    err = 1;
	} else {
	    if (zdirname != NULL) {
		*zdirname = g_strdup(gsf_infile_name_by_index(infile, 0));
	    }
	    if (path != NULL) {
		outfile = gsf_outfile_stdio_new(path, &gerr);
	    } else {
		outfile = gsf_outfile_stdio_new(".", &gerr);
	    }
	    if (outfile == NULL) {
		err = 1;
	    } else {
		err = clone_gsf_tree(GSF_INPUT(infile), GSF_OUTPUT(outfile));
	    }
	}
    }

#if ZDEBUG
    fprintf(stderr, "*** gretl_gsf_unzip_file: returning %d\n", err);
#endif

    return handle_zip_error(fname, gerr, err, "unzipping");
}

#else /* native, using gretlzip plugin, not libgsf */

#include "plugins.h"

static int gretl_plugin_unzip (const char *fname,
			       const char *path,
			       gchar **zdirname)
{
    int (*zfunc) (const char *, const char *, gchar **, GError **);
    GError *gerr = NULL;
    int err = 0;

    zfunc = get_plugin_function("gretl_native_unzip");
    if (zfunc == NULL) {
	/* error message handled by get_plugin_function() */
        return 1;
    }

#if ZDEBUG
    fprintf(stderr, "gretl_plugin_unzip: fname='%s,\npath='%s'\nzdirname=%p\n",
	    fname, path, (void *) zdirname);
#endif

    err = (*zfunc)(fname, path, zdirname, &gerr);

    return handle_zip_error(fname, gerr, err, "unzipping");
}

/*
 * @fname: full path to zipfile to be created.
 * @path: path relative to workdir for files to be picked up
 * and zipped.
 */

static int gretl_plugin_make_zipfile (const char *fname,
				      const char *path)
{
    int (*zfunc) (const char *, const char *, GError **);
    GError *gerr = NULL;
    int err = 0;

    zfunc = get_plugin_function("gretl_native_make_zipfile");
    if (zfunc == NULL) {
        return 1;
    }

    err = (*zfunc)(fname, path, &gerr);
#if ZDEBUG
    fprintf(stderr, "gretl_plugin_make_zipfile: err = %d\n", err);
#endif

    return handle_zip_error(fname, gerr, err, "zipping");
}

static int gretl_plugin_zip_datafile (const char *fname,
				      const char *path,
				      int level)
{
    int (*zfunc) (const char *, const char *, int, GError **);
    GError *gerr = NULL;
    int err = 0;

    zfunc = get_plugin_function("gretl_native_zip_datafile");
    if (zfunc == NULL) {
        return 1;
    }

    err = (*zfunc)(fname, path, level, &gerr);

    return handle_zip_error(fname, gerr, err, "zipping");
}

#endif /* zip/unzip variants */

/**
 * gretl_unzip:
 * @fname: name of the file to unzip.
 *
 * Unzips @fname in the current directory, preserving any
 * internal directory structure.
 *
 * Returns: 0 on success, non-zero code on error.
 */

int gretl_unzip (const char *fname)
{
#if USE_GSF
    return gretl_gsf_unzip(fname, NULL, NULL);
#else
    return gretl_plugin_unzip(fname, NULL, NULL);
#endif
}

/**
 * gretl_unzip_into:
 * @fname: name of the file to unzip.
 * @dirname: the name of the directory in which unzipping
 * should take place.
 *
 * Unzips @fname in the specified directory, preserving any
 * internal directory structure.
 *
 * Returns: 0 on success, non-zero code on error.
 */

int gretl_unzip_into (const char *fname, const char *dirname)
{
#if USE_GSF
    return gretl_gsf_unzip(fname, dirname, NULL);
#else
    return gretl_plugin_unzip(fname, dirname, NULL);
#endif
}

/**
 * gretl_make zipfile:
 * @fname: name of the zip file to create.
 * @path: the path to the content which should be zipped.
 *
 * Creates a zip file of the specified name, whose content
 * is determined (recursively) by @path.
 *
 * Returns: 0 on success, non-zero code on error.
 */

int gretl_make_zipfile (const char *fname, const char *path)
{
#if USE_GSF
    return gretl_gsf_make_zipfile(fname, path);
#else
    return gretl_plugin_make_zipfile(fname, path);
#endif
}

/**
 * gretl_unzip_session_file:
 * @fname: name of the file to unzip.
 * @zdirname: location to receive the name of the top-level
 * directory within the zip archive.
 *
 * Specialized (slightly) unzipper for gretl session files.
 *
 * Returns: 0 on success, non-zero code on error.
 */

int gretl_unzip_session_file (const char *fname, gchar **zdirname)
{
#if USE_GSF
    return gretl_gsf_unzip(fname, NULL, zdirname);
#else
    return gretl_plugin_unzip(fname, NULL, zdirname);
#endif
}

/**
 * gretl_zip_datafile:
 * @fname: name of the zip file to create.
 * @path: the path to the content which should be zipped.
 * @level: the zlib compression level to apply.
 *
 * Creates a zip file of the specified name, with content
 * given by @path, using the specified compression level.
 *
 * Returns: 0 on success, non-zero code on error.
 */

int gretl_zip_datafile (const char *fname, const char *path,
			int level)
{
#if USE_GSF
    return gretl_gsf_zip_datafile(fname, path, level);
#else
    return gretl_plugin_zip_datafile(fname, path, level);
#endif
}

/* below: apparatus for making a zipfile for a function
   package
*/

static void zip_report (int err, int nf, gretlopt opt, PRN *prn)
{
    if (opt & OPT_G) {
	/* GUI use */
	if (err && nf) {
	    pprintf(prn, "<@fail> (%s)\n", _("not found"));
	} else if (err) {
	    pputs(prn, "<@fail>\n");
	} else {
	    pputs(prn, "<@ok>\n");
	}
    } else {
	if (err && nf) {
	    pprintf(prn, "failed (%s)\n", _("not found"));
	} else if (err) {
	    pputs(prn, "failed\n");
	} else {
	    pputs(prn, "OK\n");
	}
    }
}

static int pkg_zipfile_add (const char *fname,
			    const char *dotpath,
			    gretlopt opt,
			    PRN *prn)
{
    gchar *dest = NULL;
    struct stat sbuf;
    int nf = 0;
    int err = 0;

    pprintf(prn, "Copying %s... ", fname);

    if (stat(fname, &sbuf) != 0) {
	nf = err = E_DATA;
    } else if (sbuf.st_mode & S_IFDIR) {
	/* aha, we've got a subdir */
	gchar *ziptmp;

	ziptmp = g_strdup_printf("%s%cpkgtmp.zip", dotpath, SLASH);
	err = gretl_make_zipfile(ziptmp, fname);
	if (!err) {
	    err = gretl_unzip_into(ziptmp, dotpath);
	    gretl_remove(ziptmp);
	}
	g_free(ziptmp);
    } else {
	/* a regular file, we hope; but if this is the PDF file
	   for a package we'll allow that it may be found in a
	   subdirectory (probably "doc")
	*/
	const char *p = strrslash(fname);

	if (p != NULL && has_suffix(fname, ".pdf")) {
	    dest = g_strdup_printf("%s%c%s", dotpath, SLASH, p + 1);
	} else {
	    dest = g_strdup_printf("%s%c%s", dotpath, SLASH, fname);
	}
	err = gretl_copy_file(fname, dest);
    }

    zip_report(err, nf, opt, prn);
    g_free(dest);

    return err;
}

/**
 * package_make_zipfile:
 * @gfnname: name of the gfn file to be zip-packaged.
 * @pdfdoc: package has PDF documentation? (0/1).
 * @datafiles: names of any data files to include (or NULL).
 * @n_datafiles: the number of strings in @datafiles.
 * @pzipname: location to receive "dotdir" zipname, or NULL.
 * @dest: specific path for output zipfile, or NULL.
 * @opt: use OPT_G for GUI use (only);
 * @prn: gretl printer for progress.
 *
 * Collects the specified gfn file plus any additional files
 * it references (PDF doc and/or data files) and makes a
 * zip archive, using the user's "dotdir" as workspace.
 * If @pzipname is non-NULL this is taken as signal to
 * leave the zipfile where it has been created, and to
 * "return" its full path via this pointer. Otherwise, if
 * @dest is non-NULL it is taken to stipulate a path to
 * which the zipfile should be moved/renamed.
 *
 * Errors are flagged if both @pzipname and @dest are NULL,
 * if @gfnname does not have the ".gfn" extension, or if
 * the basename of the gfn file (minus extension) is over
 * 32 bytes long.
 *
 * Returns: 0 on success, non-zero code on error.
 */

int package_make_zipfile (const char *gfnname,
			  int pdfdoc,
			  char **datafiles,
			  int n_datafiles,
			  gchar **pzipname,
			  const char *dest,
			  gretlopt opt,
			  PRN *prn)
{
    char pkgbase[FILENAME_MAX];
    gchar *pkgname = NULL;
    gchar *origdir = NULL;
    gchar *tmp, *dotpath = NULL;
    int len, dir_made = 0;
    int err = 0;

    if (pzipname == NULL && dest == NULL) {
	/* we need one or the other of these */
	return E_DATA;
    }

    if (!has_suffix(gfnname, ".gfn")) {
	gretl_errmsg_set("Input must have extension \".gfn\"");
	return E_DATA;
    }

    /* determine the common path to files for packaging,
       and also the name of the package
    */
    strcpy(pkgbase, gfnname);
    tmp = strrslash(pkgbase);
    if (tmp != NULL) {
	/* got some path component */
	*tmp = '\0';
	tmp++;
    } else {
	/* using current working directory */
	*pkgbase = '\0';
	tmp = (gchar *) gfnname;
    }

    len = strlen(tmp) - 4; /* minus 4 for ".gfn" */
    if (len < 0 || len > 31) {
	gretl_errmsg_set("Invalid package name (31 bytes max)");
	return E_DATA;
    }

    pkgname = g_strndup(tmp, len);

    /* record where we are now */
    origdir = g_get_current_dir();

#if 0
    fprintf(stderr, "origdir: '%s'\n", origdir);
    fprintf(stderr, "pkgbase: '%s'\n", pkgbase);
    fprintf(stderr, "pkgname: '%s'\n", pkgname);
#endif

    if (*pkgbase != '\0') {
	/* get into place for copying */
	pputs(prn, "Getting in place... ");
	err = gretl_chdir(pkgbase);
	zip_report(err, 0, opt, prn);
    }

    if (!err) {
	/* path to temporary dir for zipping */
	dotpath = g_strdup_printf("%s%s", gretl_dotdir(), pkgname);
	pputs(prn, "Making temporary directory... ");
	err = gretl_mkdir(dotpath);
	zip_report(err, 0, opt, prn);
    }

    if (!err) {
	dir_made = 1;
    }

    if (!err) {
	/* copy the gfn file into place */
	tmp = g_strdup_printf("%s.gfn", pkgname);
	err = pkg_zipfile_add(tmp, dotpath, opt, prn);
	g_free(tmp);
    }

    if (!err && pdfdoc) {
	/* copy PDF file into place */
	struct stat sbuf;

	tmp = g_strdup_printf("%s.pdf", pkgname);
	if (stat(tmp, &sbuf) != 0) {
	    g_free(tmp);
	    tmp = g_strdup_printf("doc/%s.pdf", pkgname);
	}
	err = pkg_zipfile_add(tmp, dotpath, opt, prn);
	g_free(tmp);
    }

    if (!err && datafiles != NULL) {
	/* copy data files into place, if any */
	int i;

	for (i=0; i<n_datafiles && !err; i++) {
	    err = pkg_zipfile_add(datafiles[i],
				  dotpath, opt, prn);
	}
    }

    if (!err) {
	/* get into place for making zipfile */
	err = gretl_chdir(gretl_dotdir());
	if (!err) {
	    tmp = g_strdup_printf("%s.zip", pkgname);
	    pprintf(prn, "Making %s... ", tmp);
	    err = gretl_make_zipfile(tmp, pkgname);
	    zip_report(err, 0, opt, prn);
	    if (!err) {
		if (pzipname != NULL) {
		    /* Signals that we should leave the zipfile in
		       the user's dotdir and return its name via
		       this pointer.
		    */
		    *pzipname = g_strdup_printf("%s%s.zip", gretl_dotdir(),
						pkgname);
		} else {
		    /* If we get here dest must be non-NULL,
		       but it may be a relative path, in which
		       case we need to prepend @origdir for the
		       zipfile copying operation.
		    */
		    const char *realdest = dest;
		    gchar *zipname = NULL;

		    pprintf(prn, "Copying %s... ", tmp);

		    if (origdir != NULL && !g_path_is_absolute(dest)) {
			zipname = g_build_filename(origdir, dest, NULL);
			realdest = zipname;
		    }
		    err = gretl_copy_file(tmp, realdest);
		    zip_report(err, 0, opt, prn);
		    if (strcmp(tmp, realdest)) {
			gretl_remove(tmp);
		    }
		    g_free(zipname);
		}
	    }
	    g_free(tmp);
	}
    }

    if (origdir != NULL) {
	/* get back to where we came from */
	gretl_chdir(origdir);
	g_free(origdir);
    }

    if (dir_made) {
	/* delete the temporary zip directory */
	gretl_deltree(dotpath);
    }

    g_free(dotpath);
    g_free(pkgname);

    return err;
}