//
// mutool-based PDF to PWG Raster filter function for libcupsfilters.
//
// Copyright (c) 2016, Pranjal Bhor
// Copyright (c) 2008-2016, Till Kamppeter
// Copyright (c) 2011, Tim Waugh
// Copyright (c) 2011-2013, Richard Hughes
//
// Licensed under Apache License v2.0.  See the file "LICENSE" for more
// information.
//


#include <config.h>
#include <cups/cups.h>

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <fcntl.h>
#include <cups/raster.h>
#include <cupsfilters/colormanager.h>
#include <cupsfilters/raster.h>
#include <cupsfilters/ipp.h>
#include <cupsfilters/libcups2-private.h>
#include <sys/types.h>
#include <sys/wait.h>
#include <signal.h>
#include <unistd.h>
#include <errno.h>

#define PDF_MAX_CHECK_COMMENT_LINES	20

#define CUPS_IPTEMPFILE "/tmp/ip-XXXXXX"
#define CUPS_OPTEMPFILE "/tmp/op-XXXXXX"

typedef cups_page_header_t mupdf_page_header;


static int
parse_doc_type(FILE *fp,
	       cf_logfunc_t log,
	       void *ld)
{
  char buf[5];
  char *rc;

  // get the first few bytes of the file
  rewind(fp);
  rc = fgets(buf, sizeof(buf), fp);

  // empty input
  if (rc == NULL)
    return (1);

  // is PDF
  if (strncmp(buf, "%PDF", 4) == 0)
    return (0);

  if (log) log(ld, CF_LOGLEVEL_DEBUG,
	       "cfFilterMuPDFToPWG: input file cannot be identified");

  return (-1);
}

static void
parse_pdf_header_options(FILE *fp,
			 mupdf_page_header *h)
{
  char buf[4096];
  int i;

  rewind(fp);

  // skip until PDF start header
  while (fgets(buf, sizeof(buf), fp) != 0)
    if (strncmp(buf, "%PDF", 4) == 0)
      break;
  for (i = 0; i < PDF_MAX_CHECK_COMMENT_LINES; i++)
  {
    if (fgets(buf, sizeof(buf), fp) == 0)
      break;
    if (strncmp(buf, "%%PDFTOPDFNumCopies", 19) == 0)
    {
      char *p;

      p = strchr(buf + 19, ':');
      h->NumCopies = atoi(p + 1);
    }
    else if (strncmp(buf, "%%PDFTOPDFCollate", 17) == 0)
    {
      char *p;

      p = strchr(buf + 17, ':');
      while (*p == ' ' || *p == '\t')
	p ++;
      if (strncasecmp(p, "true", 4) == 0)
        h->Collate = CUPS_TRUE;
      else
        h->Collate = CUPS_FALSE;
    }
  }
}

static void
header_to_gs_args(mupdf_page_header *h,
		  cf_filter_out_format_t outformat,
		  cups_array_t *mupdf_args)
{
  char tmpstr[1024];

  if ((h->HWResolution[0] != 100) || (h->HWResolution[1] != 100))
  {
    snprintf(tmpstr, sizeof(tmpstr), "-r%dx%d", h->HWResolution[0], 
	     h->HWResolution[1]); 
    cupsArrayAdd(mupdf_args, strdup(tmpstr));
  }
  else
  {
    snprintf(tmpstr, sizeof(tmpstr), "-r100x100");
    cupsArrayAdd(mupdf_args, strdup(tmpstr));
  }

  snprintf(tmpstr, sizeof(tmpstr), "-w%d", h->cupsWidth);
  cupsArrayAdd(mupdf_args, strdup(tmpstr));

  snprintf(tmpstr, sizeof(tmpstr), "-h%d", h->cupsHeight);
  cupsArrayAdd(mupdf_args, strdup(tmpstr));

  switch (h->cupsColorSpace)
  {
    case CUPS_CSPACE_RGB:
    case CUPS_CSPACE_CMY:
    case CUPS_CSPACE_RGBW:
    case CUPS_CSPACE_SRGB:
    case CUPS_CSPACE_ADOBERGB:
    default:
        snprintf(tmpstr, sizeof(tmpstr), "-crgb");
	break;

    case CUPS_CSPACE_CMYK:
        if (outformat == CF_FILTER_OUT_FORMAT_PWG_RASTER)
	                                     // No post-filtering needed
	  snprintf(tmpstr, sizeof(tmpstr), "-ccmyk");
	else
	  snprintf(tmpstr, sizeof(tmpstr), "-crgb");
	                                     // Post-filtering needed, only
	                                     // 3-color modes supported as
	                                     // input for the post filters*/
	break;

    case CUPS_CSPACE_SW:
        snprintf(tmpstr, sizeof(tmpstr), "-cgray");
	break;

    case CUPS_CSPACE_K:
    case CUPS_CSPACE_W:
        snprintf(tmpstr, sizeof(tmpstr), "-cmono");
	break;
  }
  cupsArrayAdd(mupdf_args, strdup(tmpstr));
}

static int
mutool_spawn(const char *filename,
	     cups_array_t *mutool_args,
	     int outputfd,
	     cf_logfunc_t log,
	     void *ld,
	     cf_filter_iscanceledfunc_t iscanceled,
	     void *icd)
{
  char *argument;
  char buf[BUFSIZ];
  char **mutoolargv;
  const char* apos;
  int errfds[2];
  int i;
  int numargs;
  int pid, mutoolpid, errpid;
  cups_file_t *logfp;
  cf_loglevel_t log_level;
  char *msg;
  int status = 65536;
  int wstatus;

  // Put mutool command line argument into an array for the "exec()"
  // call
  numargs = cupsArrayGetCount(mutool_args);
  mutoolargv = calloc(numargs + 1, sizeof(char *));
  for (argument = (char *)cupsArrayGetFirst(mutool_args), i = 0; argument;
       argument = (char *)cupsArrayGetNext(mutool_args), i++)
    mutoolargv[i] = argument;
  mutoolargv[i] = NULL;

  if (log)
  {
    // Debug output: Full mutool command line and environment variables
    snprintf(buf, sizeof(buf), "cfFilterMuPDFToPWG: mutool command line:");
    for (i = 0; mutoolargv[i]; i ++)
    {
      if ((strchr(mutoolargv[i],' ')) || (strchr(mutoolargv[i],'\t')))
	apos = "'";
      else
	apos = "";
      snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf),
	       " %s%s%s", apos, mutoolargv[i], apos);
    }
    log(ld, CF_LOGLEVEL_DEBUG, "%s", buf);
  }

  // Create a pipe for stderr output of mutool
  if (pipe(errfds))
  {
    errfds[0] = -1;
    errfds[1] = -1;
    if (log) log(ld, CF_LOGLEVEL_ERROR,
		 "cfFilterMuPDFToPWG: Unable to establish stderr pipe for mutool call");
    goto out;
  }

  // Set the "close on exec" flag on each end of the pipes...
  if (fcntl(errfds[0], F_SETFD, fcntl(errfds[0], F_GETFD) | FD_CLOEXEC))
  {
    close(errfds[0]);
    close(errfds[1]);
    errfds[0] = -1;
    errfds[1] = -1;
    if (log) log(ld, CF_LOGLEVEL_ERROR,
		 "cfFilterMuPDFToPWG: Unable to set \"close on exec\" flag on read end of the stderr pipe for mutool call");
    goto out;
  }
  if (fcntl(errfds[1], F_SETFD, fcntl(errfds[1], F_GETFD) | FD_CLOEXEC))
  {
    close(errfds[0]);
    close(errfds[1]);
    if (log) log(ld, CF_LOGLEVEL_ERROR,
		 "cfFilterMuPDFToPWG: Unable to set \"close on exec\" flag on write end of the stderr pipe for mutool call");
    goto out;
  }

  if ((mutoolpid = fork()) == 0)
  {
    // Couple errfds pipe with stdin of mutool process
    if (errfds[1] >= 2)
    {
      if (errfds[1] != 2)
      {
	if (dup2(errfds[1], 2) < 0)
	{
	  if (log) log(ld, CF_LOGLEVEL_ERROR,
		       "cfFilterMuPDFToPWG: Unable to couple pipe with stderr of mutool process");
	  exit(1);
	}
	close(errfds[1]);
      }
      close(errfds[0]);
    }
    else
    {
      if (log) log(ld, CF_LOGLEVEL_ERROR,
		   "cfFilterMuPDFToPWG: invalid pipe file descriptor to couple with stderr of mutool process");
      exit(1);
    }

    // Couple stdout of mutool process
    if (outputfd >= 1)
    {
      if (outputfd != 1)
      {
	if (dup2(outputfd, 1) < 0)
	{
	  if (log) log(ld, CF_LOGLEVEL_ERROR,
		       "cfFilterMuPDFToPWG: Unable to couple stdout of mutool process");
	  exit(1);
	}
	close(outputfd);
      }
    }
    else
    {
      if (log) log(ld, CF_LOGLEVEL_ERROR,
		   "cfFilterMuPDFToPWG: Invalid file descriptor to couple with stdout of mutool process");
      exit(1);
    }

    // Execute mutool command line ...
    execvp(filename, mutoolargv);
    if (log) log(ld, CF_LOGLEVEL_ERROR,
		 "cfFilterMuPDFToPWG: Unable to launch mutool: %s: %s",
		 filename, strerror(errno));
    exit(1);
  }
  if (log) log(ld, CF_LOGLEVEL_DEBUG,
	       "cfFilterMuPDFToPWG: Started mutool (PID %d)", mutoolpid);

  close(errfds[1]);

  if ((errpid = fork()) == 0)
  {
    logfp = cupsFileOpenFd(errfds[0], "r");
    while (cupsFileGets(logfp, buf, sizeof(buf)))
      if (log)
      {
	if (strncmp(buf, "DEBUG: ", 7) == 0)
	{
	  log_level = CF_LOGLEVEL_DEBUG;
	  msg = buf + 7;
	}
	else if (strncmp(buf, "DEBUG2: ", 8) == 0)
	{
	  log_level = CF_LOGLEVEL_DEBUG;
	  msg = buf + 8;
	}
	else if (strncmp(buf, "INFO: ", 6) == 0)
	{
	  log_level = CF_LOGLEVEL_INFO;
	  msg = buf + 6;
	}
	else if (strncmp(buf, "WARNING: ", 9) == 0)
	{
	  log_level = CF_LOGLEVEL_WARN;
	  msg = buf + 9;
	}
	else if (strncmp(buf, "ERROR: ", 7) == 0)
	{
	  log_level = CF_LOGLEVEL_ERROR;
	  msg = buf + 7;
	}
	else
	{
	  log_level = CF_LOGLEVEL_DEBUG;
	  msg = buf;
	}
	log(ld, log_level, "cfFilterMuPDFToPWG: %s", msg);
      }
    cupsFileClose(logfp);
    // No need to close the fd errfds[0], as cupsFileClose(fp) does this
    // already
    // Ignore errors of the logging process
    exit(0);
  }
  if (log) log(ld, CF_LOGLEVEL_DEBUG,
	       "cfFilterMuPDFToPWG: Started logging (PID %d)", errpid);

  close(errfds[0]);

  //
  // Initialize to exit status 'Success' first - any error exit status
  // from children process will rewrite it, and wait for children..
  //

  status = 0;

  while (mutoolpid > 0 || errpid > 0)
  {
    if ((pid = wait(&wstatus)) < 0)
    {
      if (errno == EINTR && iscanceled && iscanceled(icd))
      {
	if (log) log(ld, CF_LOGLEVEL_DEBUG,
		     "cfFilterMuPDFToPWG: Job canceled, killing mutool ...");
	kill(mutoolpid, SIGTERM);
	mutoolpid = -1;
	kill(errpid, SIGTERM);
	errpid = -1;
	break;
      } else
	continue;
    }

    // How did the filter terminate
    if (wstatus)
    {
      if (WIFEXITED(wstatus))
      {
	// Via exit() anywhere or return() in the main() function
	if (log) log(ld, CF_LOGLEVEL_ERROR,
		     "cfFilterMuPDFToPWG: %s (PID %d) stopped with status %d",
		     (pid == mutoolpid ? "mutool" : "Logging"), pid,
		     WEXITSTATUS(wstatus));
	status = WEXITSTATUS(wstatus);
      }
      else
      {
	// Via signal
	if (log) log(ld, CF_LOGLEVEL_ERROR,
		     "cfFilterMuPDFToPWG: %s (PID %d) crashed on signal %d",
		     (pid == mutoolpid ? "mutool" : "Logging"), pid,
		     WTERMSIG(wstatus));
	status = 256 * WTERMSIG(wstatus);
      }
    }
    else
    {
      if (log) log(ld, CF_LOGLEVEL_DEBUG,
		   "cfFilterMuPDFToPWG: %s (PID %d) exited with no errors.",
		   (pid == mutoolpid ? "mutool" : "Logging"), pid);
    }
    if (pid == mutoolpid)
      mutoolpid = -1;
    else  if (pid == errpid)
      errpid = -1;
  }

out:
  free(mutoolargv);
  return (status);
}


int
cfFilterMuPDFToPWG(int inputfd,         // I - File descriptor input stream
		   int outputfd,        // I - File descriptor output stream
		   int inputseekable,   // I - Is input stream seekable?
					//     (unused)
		   cf_filter_data_t *data, // I - Job and printer data
		   void *parameters)    // I - Filter-specific parameters
                                        //     (unused)
{
  cf_filter_out_format_t outformat;
  char *val;
  char buf[BUFSIZ];
  char *icc_profile = NULL;
  char tmpstr[1024];
  cups_array_t *mupdf_args = NULL;
  FILE *fp = NULL;
  char infilename[1024];
  mupdf_page_header h;
  int fd = -1;
  int cm_disabled = 0;
  int n;
  int empty = 0;
  int status = 1;
  struct sigaction sa;
  cf_cm_calibration_t cm_calibrate;
  cf_logfunc_t log = data->logfunc;
  void *ld = data->logdata;
  cf_filter_iscanceledfunc_t iscanceled = data->iscanceledfunc;
  void *icd = data->iscanceleddata;
  cups_cspace_t cspace = -1;

  (void)inputseekable;
  (void)parameters;

  val = data->final_content_type;
  if (val)
  {
    if (strcasestr(val, "pwg"))
      outformat = CF_FILTER_OUT_FORMAT_PWG_RASTER;
    else if (strcasestr(val, "urf"))
      outformat = CF_FILTER_OUT_FORMAT_APPLE_RASTER;
    else if (strcasestr(val, "pclm"))
      outformat = CF_FILTER_OUT_FORMAT_PCLM;
    else if (strcasestr(val, "cups"))
      outformat = CF_FILTER_OUT_FORMAT_CUPS_RASTER;
    else
      outformat = CF_FILTER_OUT_FORMAT_PWG_RASTER;
  }
  else
    outformat = CF_FILTER_OUT_FORMAT_PWG_RASTER;

  if (log) log(ld, CF_LOGLEVEL_DEBUG,
	       "cfFilterMuPDFToPWG: Output format: %s",
	       (outformat == CF_FILTER_OUT_FORMAT_CUPS_RASTER ? "CUPS Raster" :
		(outformat == CF_FILTER_OUT_FORMAT_PWG_RASTER ? "PWG Raster" :
		 (outformat == CF_FILTER_OUT_FORMAT_APPLE_RASTER ? "Apple Raster" :
		  "PCLM"))));

  memset(&sa, 0, sizeof(sa));
  // Ignore SIGPIPE and have write return an error instead
  sa.sa_handler = SIG_IGN;
  sigaction(SIGPIPE, &sa, NULL);

  fd = cupsCreateTempFd(NULL, NULL, infilename, 1024);
  if (fd < 0)
  {
    if (log) log(ld, CF_LOGLEVEL_ERROR,
		 "cfFilterMuPDFToPWG: Can't create temporary file");
    goto out;
  }

  // copy input file to the tmp file
  while ((n = read(inputfd, buf, BUFSIZ)) > 0)
  {
    if (write(fd, buf, n) != n)
    {
      if (log) log(ld, CF_LOGLEVEL_ERROR,
		   "cfFilterMuPDFToPWG: Can't copy input to temporary file");
      close(fd);
      goto out;
    }
  }

  if (!inputfd)
  {
    if (lseek(fd, 0, SEEK_SET) < 0)
    {
      if (log) log(ld, CF_LOGLEVEL_ERROR,
		   "cfFilterMuPDFToPWG: Can't rewind temporary file");
      close(fd);
      goto out;
    }

    if ((fp = fdopen(fd, "rb")) == 0)
    {
      if (log) log(ld, CF_LOGLEVEL_ERROR,
		   "cfFilterMuPDFToPWG: Can't open temporary file");
      close(fd);
      goto out;
    }
  }
  else
  {
    // filename is specified

    if ((fp = fdopen(fd, "rb")) == 0)
    {
      if (log) log(ld, CF_LOGLEVEL_ERROR,
		   "cfFilterMuPDFToPWG: Can't open temporary file");
      goto out;
    }
  }

  // If doc type is not PDF exit
  empty = parse_doc_type(fp, log, ld);
  if (empty == -1)
    goto out;

  // mutool parameters
  mupdf_args = cupsArrayNew(NULL, NULL, NULL, 0, NULL, NULL);
  if (!mupdf_args)
  {
    if (log) log(ld, CF_LOGLEVEL_ERROR,
		 "cfFilterMuPDFToPWG: Unable to allocate memory for mutool arguments array");
    goto out;
  }

  if (log) log(ld, CF_LOGLEVEL_DEBUG,
	       "cfFilterMuPDFToPWG: command: %s",
	       CUPS_MUTOOL);
  snprintf(tmpstr, sizeof(tmpstr), "%s", CUPS_MUTOOL);
  cupsArrayAdd(mupdf_args, strdup(tmpstr));
  cupsArrayAdd(mupdf_args, strdup("draw"));
  cupsArrayAdd(mupdf_args, strdup("-L"));
  cupsArrayAdd(mupdf_args, strdup("-o-"));
  cupsArrayAdd(mupdf_args, strdup("-smtf"));

  // mutool output parameters
  cupsArrayAdd(mupdf_args, strdup("-Fpwg"));

  // Note that MuPDF only creates PWG Raster so we select this as header format,
  // We also supply the final output format (to which will be converted with
  // further filters) to determine the correct color space and depth.
  // From the header h only cupsWidth/cupsHeight (dimensions in pixels),
  // resolution, and color space are used here.
  cfRasterPrepareHeader(&h, data, outformat,
			CF_FILTER_OUT_FORMAT_PWG_RASTER, 1, &cspace);

  // set PDF-specific options
  parse_pdf_header_options(fp, &h);

  // fixed other values that pdftopdf handles
  h.MirrorPrint = CUPS_FALSE;
  h.Orientation = CUPS_ORIENT_0;

  // Check status of color management in CUPS
  cm_calibrate = cfCmGetCupsColorCalibrateMode(data);

  if (cm_calibrate == CF_CM_CALIBRATION_ENABLED)
    cm_disabled = 1;
  else
    cm_disabled = cfCmIsPrinterCmDisabled(data);

  if (!cm_disabled)
    cfCmGetPrinterIccProfile(data, cfRasterColorSpaceString(h.cupsColorSpace),
			     h.MediaType, h.HWResolution[0], h.HWResolution[1],
			     &icc_profile);

  // Note: No ICC profile support in mutool!

  //  Find print-rendering-intent
  h.cupsRenderingIntent[0] = '\0';
  cfGetPrintRenderIntent(data, h.cupsRenderingIntent,
			 sizeof(h.cupsRenderingIntent));
  if (log) log(ld, CF_LOGLEVEL_DEBUG,
	       "Print rendering intent = %s", h.cupsRenderingIntent);

  // get all the data from the header and pass it to mutool
  header_to_gs_args(&h, outformat, mupdf_args);

  snprintf(tmpstr, sizeof(tmpstr), "%s", infilename);
  cupsArrayAdd(mupdf_args, strdup(tmpstr));

  // Execute mutool command line ...
  snprintf(tmpstr, sizeof(tmpstr), "%s", CUPS_MUTOOL);
		
  // call mutool
  status = mutool_spawn (tmpstr, mupdf_args, outputfd, log, ld,
			 iscanceled, icd);
  if (status != 0)
    status = 1;

  if (empty)
  {
    if (log) log(ld, CF_LOGLEVEL_ERROR,
		 "cfFilterMuPDFToPWG: Input is empty, outputting empty file.");
    status = 0;
  }

out:
  close(outputfd);
  if (fp)
    fclose(fp);
  if (mupdf_args) 
    cupsArrayDelete(mupdf_args);

  free(icc_profile);

  if (fd >= 0)
    unlink(infilename);

  return (status);
}