/*
 * Copyright (c) 1994-2024 Paul Mattes.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the names of Paul Mattes nor the names of his contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY PAUL MATTES "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL PAUL MATTES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 *	print_screen.c
 *		Screen printing functions.
 */

#include "globals.h"

#include "appres.h"
#include "3270ds.h"
#include "ctlr.h"

#include "ctlrc.h"

#include <errno.h>
#include <assert.h>

#include "resources.h"

#include "actions.h"
#include "codepage.h"
#include "fprint_screen.h"
#include "names.h"
#include "popups.h"
#include "print_command.h"
#include "print_screen.h"
#include "print_gui.h"
#include "product.h"
#include "task.h"
#include "toggles.h"
#include "trace.h"
#include "txa.h"
#include "unicodec.h"
#include "utils.h"

#if defined(_WIN32) /*[*/
# include <fcntl.h>
# include <sys/stat.h>
# include "w3misc.h"
# include "winprint.h"
#endif /*]*/

/* Typedefs */

/* Saved context for a suspended PrintText(). */
typedef struct {
    FILE *f;		/* temporary file */
    ptype_t ptype;	/* print type */
    unsigned opts;	/* options */
    const char *caption; /* caption text */
    const char *name;	/* printer name */
    char *temp_name;	/* temporary file name */
} printtext_t;

/* Globals */

/* Statics */

/**
 * Default caption.
 *
 * @return caption text
 */
char *
default_caption(void)
{
    static char *r = NULL;

#if !defined(_WIN32) /*[*/
    /* Unix version: username@host %T% */
    char hostname[132];
    char *user;

    gethostname(hostname, sizeof(hostname));
    hostname[sizeof(hostname) - 1] = '\0';
    user = getenv("USER");
    if (user == NULL) {
	user = "(unknown)";
    }

    if (r != NULL) {
	Free(r);
    }
    r = Asprintf("%s @ %s %%T%%", user, hostname);

#else /*][*/

    char *username;
    char *computername;
    char *userdomain;
    char ComputerName[MAX_COMPUTERNAME_LENGTH + 1];

    username = getenv("USERNAME");
    if (username == NULL) {
	username = "(unknown)";
    }
    computername = getenv("COMPUTERNAME");
    if (computername == NULL) {
	DWORD size = MAX_COMPUTERNAME_LENGTH + 1;

	if (GetComputerName(ComputerName, &size)) {
	    computername = ComputerName;
	} else {
	    computername = "(unknown)";
	}
    }
    userdomain = getenv("USERDOMAIN");
    if (userdomain == NULL) {
	userdomain = "(unknown)";
    }

    if (r != NULL) {
	Free(r);
    }
    if (strcasecmp(userdomain, computername)) {
	r = Asprintf("%s\\%s @ %s %%T%%", userdomain, username, computername);
    } else {
	r = Asprintf("%s @ %s %%T%%", username, computername);
    }
#endif

    return r;
}

/* Extended-wait continue function for PrintText(). */
static void
printtext_continue(void *context, bool cancel)
{
    printtext_t *pt = (printtext_t *)context;
    fps_status_t status;

    if (cancel) {
	vtrace("PrintText canceled\n");
	fclose(pt->f);
	if (pt->temp_name != NULL) {
	    unlink(pt->temp_name);
	    Free(pt->temp_name);
	}
	Free(pt);
	return;
    }

    status = fprint_screen(pt->f, pt->ptype, pt->opts | FPS_DIALOG_COMPLETE,
	    pt->caption, pt->name, NULL);
    switch (status) {
    case FPS_STATUS_SUCCESS:
    case FPS_STATUS_SUCCESS_WRITTEN:
	vtrace("PrintText: printing succeeded.\n");
	break;
    case FPS_STATUS_ERROR:
	popup_an_error("Screen print failed");
	/* fall through */
    case FPS_STATUS_CANCEL:
	if (status == FPS_STATUS_CANCEL) {
	    vtrace("PrintText: printing canceled.\n");
	}
	break;
    case FPS_STATUS_WAIT:
	/* Can't happen. */
	assert(status != FPS_STATUS_WAIT);
	break;
    }

    fclose(pt->f);
    if (pt->temp_name != NULL) {
	unlink(pt->temp_name);
	Free(pt->temp_name);
    }
    Free(pt);
}

/* Print or save the contents of the screen as text. */
bool
PrintText_action(ia_t ia, unsigned argc, const char **argv)
{
    enum { PM_NONE, PM_FILE, PM_GDI, PM_COMMAND, PM_STRING } mode = PM_NONE;
    unsigned i;
    const char *name = NULL;
    char *dyn_name = NULL;
    bool secure = appres.secure;
    ptype_t ptype = P_NONE;
    bool replace = false;
    char *temp_name = NULL;
    unsigned opts = FPS_EVEN_IF_EMPTY;
    const char *caption = NULL;
    FILE *f;
    int fd = -1;
    fps_status_t status;
    printtext_t *pt;
    bool any_file_options = false;
#if defined(_WIN32) /*[*/
    bool any_gdi_options = false;
#endif /*]*/
    bool use_file = false;

    if (!appres.interactive.print_dialog) {
	opts |= FPS_NO_DIALOG;
    }

    action_debug(AnPrintText, ia, argc, argv);

    /*
     * Pick off optional arguments:
     *  file     directs the output to a file instead of a command;
     *  	      must be the last keyword
     *  html     generates HTML output instead of ASCII text (and implies
     *            'file')
     *  rtf      generates RTF output instead of ASCII text (and implies
     *            'file')
     *  gdi      prints to a GDI printer (Windows only)
     *  nodialog skip print dialog (Windows only)
     *            this is the default for ws3270
     *  dialog	 use print dialog (Windows only)
     *            this is the default for wc3270
     *  replace  replace the file
     *  append   append to the file, if it exists (default)
     *  modi     print modified fields in italics
     *  oia	 include the OIA in the output
     *  caption "text"
     *           Adds caption text above the screen
     *           %T% is replaced by a timestamp
     *  secure   disables the pop-up dialog, if this action is invoked from
     *            a keymap (x3270 only)
     *  command  directs the output to a command (this is the default, but
     *            allows the command to be one of the other keywords);
     *  	      must be the last keyword
     *  string   returns the data as a string
     */
    for (i = 0; i < argc; i++) {
	if (!strcasecmp(argv[i], KwFile)) {
	    if (mode != PM_NONE) {
		popup_an_error(AnPrintText "(): contradictory option '%s'",
			argv[i]);
		return false;
	    }
	    mode = PM_FILE;
	    i++;
	    break;
	} else if (!strcasecmp(argv[i], KwHtml)) {
	    if (ptype != P_NONE) {
		popup_an_error(AnPrintText "(): contradictory option '%s'",
			argv[i]);
		return false;
	    }
	    ptype = P_HTML;
	} else if (!strcasecmp(argv[i], KwRtf)) {
	    if (ptype != P_NONE) {
		popup_an_error(AnPrintText "(): contradictory option '%s'",
			argv[i]);
		return false;
	    }
	    ptype = P_RTF;
	} else if (!strcasecmp(argv[i], KwReplace)) {
	    replace = true;
	    any_file_options = true;
	} else if (!strcasecmp(argv[i], KwAppend)) {
	    replace = false;
	    any_file_options = true;
	}
#if defined(_WIN32) /*[*/
	else if (!strcasecmp(argv[i], KwGdi)) {
	    if (mode != PM_NONE) {
		popup_an_error(AnPrintText "(): contradictory option '%s'",
			argv[i]);
		return false;
	    }
	    mode = PM_GDI;
	} else if (!strcasecmp(argv[i], KwNoDialog)) {
	    opts |= FPS_NO_DIALOG;
	    any_gdi_options = true;
	} else if (!strcasecmp(argv[i], KwDialog)) {
	    opts &= ~FPS_NO_DIALOG;
	    any_gdi_options = true;
	}
#endif /*]*/
	else if (!strcasecmp(argv[i], KwSecure)) {
	    secure = true;
	}
#if !defined(_WIN32) /*[*/
	else if (!strcasecmp(argv[i], KwCommand)) {
	    if (mode != PM_NONE) {
		popup_an_error(AnPrintText "(): contradictory option '%s'",
			argv[i]);
		return false;
	    }
	    mode = PM_COMMAND;
	    i++;
	    break;
	}
#endif /*]*/
	else if (!strcasecmp(argv[i], KwString)) {
	    if (mode != PM_NONE) {
		popup_an_error(AnPrintText "(): contradictory option '%s'",
			argv[i]);
		return false;
	    }
	    mode = PM_STRING;
	} else if (!strcasecmp(argv[i], KwModi)) {
	    opts |= FPS_MODIFIED_ITALIC;
	} else if (!strcasecmp(argv[i], KwCaption)) {
	    if (i == argc - 1) {
		popup_an_error(AnPrintText "(): missing " KwCaption
			" parameter");
		return false;
	    }
	    caption = argv[++i];
	} else if (!strcasecmp(argv[i], KwOia)) {
	    opts |= FPS_OIA;
	} else {
	    break;
	}
    }

    /* Set the default mode, if none has been selected. */
    if (mode == PM_NONE) {
#if !defined(_WIN32) /*[*/
	mode = PM_COMMAND;
#else /*][*/
	mode = PM_GDI;
#endif /*]*/
    }

    /* Root out some additional option conflicts. */
    if (any_file_options && mode != PM_FILE) {
	popup_an_error(AnPrintText "(): " KwFile "-related option(s) given "
		"when not printing to file");
	return false;
    }
#if defined(_WIN32) /*[*/
    if (any_gdi_options && mode != PM_GDI) {
	popup_an_error(AnPrintText "(): " KwGdi "-related option(s) given "
		"when not printing via GDI");
	return false;
    }
#endif /*]*/

    /* Handle positional options. */
    switch (argc - i) {
    case 0:
	/* Use the default command or printer. */
#if !defined(_WIN32) /*[*/
	if (mode == PM_COMMAND) {
	    name = get_resource(ResPrintTextCommand);
	    if (name == NULL || !*name) {
		name = "lpr";
	    }
	}
#else /*][*/
	if (mode == PM_GDI) {
	    name = get_resource(ResPrinterName);
	}
#endif /*]*/
	break;
    case 1:
	if (mode == PM_STRING) {
	    popup_an_error(AnPrintText "(): extra argument "
		    "with '" KwString "'");
	    return false;
	}
	name = argv[i];
	break;
    default:
	popup_an_error(AnPrintText "(): extra arguments");
	return false;
    }

#if defined(_WIN32) /*[*/
    /*
     * If using the printer, but the printer name is a directory, switch to
     * target FILE, type TEXT, and print to a file in that directory.
     *
     * This allows pr3287, screen tracing and screen printing to print text
     * to files by setting printer.name to a directory name.
     */
    if (mode == PM_GDI) {
        struct stat buf;

        if (name != NULL && stat(name, &buf) == 0 && (buf.st_mode & S_IFMT) == S_IFDIR) {
            mode = PM_FILE;
            ptype = P_TEXT;
	    name = dyn_name = print_file_name(name);
        }
    }

#endif /*]*/

    /* Infer the type from the file suffix. */
    if (mode == PM_FILE && ptype == P_NONE && name != NULL) {
	size_t sl = strlen(name);

	if ((sl > 5 && !strcasecmp(name + sl - 5, ".html")) ||
	    (sl > 4 && !strcasecmp(name + sl - 4, ".htm"))) {
	    ptype = P_HTML;
	} else if (sl > 4 && !strcasecmp(name + sl - 4, ".rtf")) {
	    ptype = P_RTF;
	}
    }

    /* Figure out the default ptype, if still not selected. */
    if (ptype == P_NONE) {
	if (mode == PM_GDI) {
	    ptype = P_GDI;
	} else {
	    ptype = P_TEXT;
	}
    }

    if (name != NULL && name[0] == '@') {
	/*
	 * Starting the PrintTextCommand resource value with '@'
	 * suppresses the pop-up dialog, as does setting the 'secure'
	 * resource.
	 */
	secure = true;
	name++;
    }

    /* See if the GUI wants to handle it. */
    if (!secure && print_text_gui(mode == PM_FILE)) {
	return true;
    }

    /* Do the real work. */
    use_file = (mode == PM_FILE || mode == PM_STRING);
    if (use_file) {
	if (mode == PM_STRING) {
#if defined(_WIN32) /*[*/
	    fd = win_mkstemp(&temp_name, ptype);
#else /*][*/
	    temp_name = NewString("/tmp/x3hXXXXXX");
	    fd = mkstemp(temp_name);
#endif /*]*/
	    if (fd < 0) {
		popup_an_errno(errno, "mkstemp");
		return false;
	    }
	    f = fdopen(fd, "w+");
	    vtrace("PrintText: using '%s'\n", temp_name);
	} else {
	    if (name == NULL || !*name) {
		popup_an_error(AnPrintText "(): missing filename");
		return false;
	    }
	    f = fopen(name, replace? "w": "a");
	}
    } else {
#if !defined(_WIN32) /*[*/
	const char *expanded_name;
	char *pct_e;

	if ((pct_e = strstr(name, "%E%")) != NULL) {
	    expanded_name = txAsprintf("%.*s%s%s",
		    (int)(pct_e - name), name,
		    programname,
		    pct_e + 3);
	} else {
	    expanded_name = name;
	}
	f = printer_open(expanded_name, NULL);
#else /*][*/
	fd = win_mkstemp(&temp_name, ptype);
	if (fd < 0) {
	    popup_an_errno(errno, "mkstemp");
	    return false;
	}
	if (ptype == P_GDI) {
	    f = fdopen(fd, "wb+");
	} else {
	    f = fdopen(fd, "w+");
	}
	vtrace("PrintText: using '%s'\n", temp_name);
#endif /*]*/
    }
    if (f == NULL) {
	popup_an_errno(errno, AnPrintText "(): %s", name);
	if (fd >= 0) {
	    close(fd);
	}
	if (temp_name) {
	    unlink(temp_name);
	    Free(temp_name);
	}
	if (dyn_name) {
	    Free(dyn_name);
	}
	return false;
    }

    if (dyn_name != NULL) {
	Free(dyn_name);
	name = NULL;
    }

    /* Captions look nice on GDI, so create a default one. */
    if (ptype == P_GDI && caption == NULL) {
	caption = default_caption();
    }

    pt = (printtext_t *)Calloc(1, sizeof(printtext_t));
    status = fprint_screen(f, ptype, opts, caption, name, pt);
    switch (status) {
    case FPS_STATUS_SUCCESS:
    case FPS_STATUS_SUCCESS_WRITTEN:
	vtrace("PrintText: printing succeeded.\n");
	Free(pt);
	fflush(f);
	break;
    case FPS_STATUS_ERROR:
	popup_an_error("Screen print failed.");
	/* fall through */
    case FPS_STATUS_CANCEL:
	if (status == FPS_STATUS_CANCEL) {
	    vtrace("PrintText: printing canceled.\n");
	}
	Free(pt);
	fclose(f);
	if (temp_name) {
	    unlink(temp_name);
	    Free(temp_name);
	}
	return false;
    case FPS_STATUS_WAIT:
	/* Waiting for asynchronous activity. */
	assert(ptype == P_GDI);
	pt->f = f;
	pt->ptype = ptype;
	pt->opts = opts;
	pt->caption = caption;
	pt->name = name;
	pt->temp_name = temp_name;
	task_xwait(pt, printtext_continue, "printing");
	return true;
    }

    if (mode == PM_STRING) {
	char buf[8192];

	/* Print to string. */
	fflush(f);
	rewind(f);
	while (fgets(buf, sizeof(buf), f) != NULL) {
	    action_output("%s", buf);
	}
	fclose(f);
	unlink(temp_name);
	Free(temp_name);
	return true;
    }

    fclose(f);
    if (use_file) {
	/* Print to specified file. */
	return true;
    }

    /* Print to printer. */
#if defined(_WIN32) /*[*/
    unlink(temp_name);
    if (appres.interactive.do_confirms) {
	popup_an_info("Screen image printing.\n");
    }
#endif /*]*/
    Free(temp_name);
    return true;
}

#if defined(_WIN32) /*[*/
char *
print_file_name(const char *dir)
{
    int iter = 0;
    char *path = NULL;
    time_t t = time(NULL);
    struct tm *tm = localtime(&t);

    /* Parts of the printer file name. */
#   define PATH_PFX	"%s\\print-%04d%02d%02d-%02d%02d%02d"
#   define PATH_ITER	".%d"
#   define PATH_SFX	".txt"

    while (true) {
	path = Asprintf(iter? PATH_PFX PATH_ITER PATH_SFX: PATH_PFX PATH_SFX,
	    dir,
	    tm->tm_year + 1900,
	    tm->tm_mon + 1,
	    tm->tm_mday,
	    tm->tm_hour,
	    tm->tm_min,
	    tm->tm_sec,
	    iter);
	if (access(path, F_OK) == 0) {
	    iter++;
	    free(path);
	    continue;
	} else {
	    break;
	}
    }
    return path;
}
#endif /*]*/

/**
 * Print screen module registration.
 */
void
print_screen_register(void)
{
    static action_table_t print_text_actions[] = {
	{ AnPrintText,		PrintText_action,	ACTION_KE },
    };

    /* Register the actions. */
    register_actions(print_text_actions, array_count(print_text_actions));
}
