ghostscript-printer-app.c

//
// Ghostscript (Foomatic) Printer Application based on PAPPL and
// libpappl-retrofit
//
// Copyright © 2020-2021 by Till Kamppeter.
// Copyright © 2020 by Michael R Sweet.
//
// Licensed under Apache License v2.0.  See the file "LICENSE" for more
// information.
//

//
// Include necessary headers...
//

#include <pappl-retrofit.h>


//
// Constants...
//

// Name and version

#define SYSTEM_NAME "Ghostscript Printer Application"
#define SYSTEM_PACKAGE_NAME "ghostscript-printer-app"
#ifndef SYSTEM_VERSION_STR
#  define SYSTEM_VERSION_STR "1.0"
#endif
#ifndef SYSTEM_VERSION_ARR_0
#  define SYSTEM_VERSION_ARR_0 1
#endif
#ifndef SYSTEM_VERSION_ARR_1
#  define SYSTEM_VERSION_ARR_1 0
#endif
#ifndef SYSTEM_VERSION_ARR_2
#  define SYSTEM_VERSION_ARR_2 0
#endif
#ifndef SYSTEM_VERSION_ARR_3
#  define SYSTEM_VERSION_ARR_3 0
#endif
#define SYSTEM_WEB_IF_FOOTER "Copyright &copy; 2021 by Till Kamppeter. Provided under the terms of the <a href=\"https://www.apache.org/licenses/LICENSE-2.0\">Apache License 2.0</a>."

// Test page

#define TESTPAGE "testpage.ps"


//
// Spooling conversions
//

// When using the fxlinuxprint driver for the non-IPP-driverless PDF
// printers from Fuji Xerox convert PDF with the driver's "pdftopdffx"
// filter

// Raster input does not need extra conversion rules, here we make use
// of the PostScript input support of the driver

static pr_spooling_conversion_t ghostscript_convert_pdf_to_fx_pdf =
{
  "application/pdf",
  "application/vnd.cups-pdfprintfx",
  2,
  {
    {
      cfFilterPDFToPDF,
      NULL,
      "pdftopdf"
    },
    {
      ppdFilterExternalCUPS,
      &((cf_filter_external_t){
	"pdftopdffx",
	0,
	0,
	NULL,
	NULL
      }),
      "pdftopdffx"
    }
  }
};


//
// 'ghostscript_autoadd()' - Auto-add printers.
//

const char *			        // O - Driver name or `NULL` for none
ghostscript_autoadd(const char *device_info,	// I - Device name (unused)
	     const char *device_uri,	// I - Device URI (unused)
	     const char *device_id,	// I - IEEE-1284 device ID
	     void       *data)          // I - Global data
{
  pr_printer_app_global_data_t *global_data =
    (pr_printer_app_global_data_t *)data;
  const char	*ret = NULL;		// Return value


  (void)device_info;
  (void)device_uri;

  if (device_id == NULL || global_data == NULL)
    return (NULL);

  // 
  // Find the best-matching PPD file to expicitly support our printer model
  if (!((ret = prBestMatchingPPD(device_id, global_data)) != 0 ||
	// No dedicated support for this model, look at the COMMAND
	// SET (CMD) key in the device ID for the list of printer
	// languages and select a generic driver if we find a
	// supported language
	(prSupportsPostScript(device_id) &&
	 (ret = prBestMatchingPPD("MFG:Generic;MDL:PostScript Printer;",
				     global_data)) != 0) ||
	(prSupportsPCLXL(device_id) &&
	 (ret = prBestMatchingPPD("MFG:Generic;MDL:PCL 6/PCL XL Printer;",
				   global_data)) != 0) ||
	(prSupportsPCL5c(device_id) &&
	 (ret = prBestMatchingPPD("MFG:Generic;MDL:PCL 5c Printer;",
				     global_data)) != 0) ||
	(prSupportsPCL5(device_id) &&
	 (ret = prBestMatchingPPD("MFG:Generic;MDL:PCL 5e Printer;",
				     global_data)) != 0)))
    // Printer does not support our PDL, it is not supported by this
    // Printer Application
    ret = NULL;

  return (ret);
}


//
// 'ghostscript_printer_setup()' - Register per-printer web pages.
//

static void
ghostscript_printer_setup(pappl_printer_t *printer,	// I - Printer
			  void            *data)	// I - Global data
{
  pappl_system_t *system = papplPrinterGetSystem(printer);
  char		 path[256];		// Device settings page path


  // Keep pappl-retrofit's setup: besides the "Device Settings" page it also
  // publishes the PPD's human-readable strings, which IPP clients fetch
  // through printer-strings-uri whether or not the web interface is on.
  prSetupDeviceSettingsPage(printer, data);

  // pappl-retrofit registers that admin page without checking the server
  // options; honour "-o server-options=no-web-interface" the same way PAPPL's
  // own printer pages do so no admin form stays reachable once the web
  // interface is disabled.
  if (!(papplSystemGetOptions(system) & PAPPL_SOPTIONS_WEB_INTERFACE))
  {
    papplPrinterGetPath(printer, "device", path, sizeof(path));
    papplSystemRemoveResource(system, path);
    papplPrinterRemoveLink(printer, "Device Settings");
  }
}


//
// 'ghostscript_not_found()' - Answer a request with 404 Not Found.
//

static bool
ghostscript_not_found(pappl_client_t *client,	// I - Client
		      void           *data)	// I - Global data (unused)
{
  (void)data;

  return (papplClientRespond(client, HTTP_STATUS_NOT_FOUND, NULL, NULL, 0, 0));
}


//
// 'ghostscript_system_setup()' - Extra setup steps for the system.
//

static void
ghostscript_system_setup(void *data)	// I - Global data
{
  pappl_system_t *system =
    prGetSystem((pr_printer_app_global_data_t *)data);


  // PAPPL registers /logs and /logfile.txt in papplSystemRun() whenever
  // web-log is set, independent of the web interface, so no-web-interface
  // alone still serves the log to every client. The first registration of a
  // path wins, so claim both paths here with 404 handlers.
  if (!(papplSystemGetOptions(system) & PAPPL_SOPTIONS_WEB_INTERFACE))
  {
    papplSystemAddResourceCallback(system, "/logs", "text/html",
				   (pappl_resource_cb_t)ghostscript_not_found,
				   NULL);
    papplSystemAddResourceCallback(system, "/logfile.txt", "text/plain",
				   (pappl_resource_cb_t)ghostscript_not_found,
				   NULL);
  }
}


//
// 'main()' - Main entry for the ghostscript-printer-app.
//

int
main(int  argc,				// I - Number of command-line arguments
     char *argv[])			// I - Command-line arguments
{
  cups_array_t *spooling_conversions,
               *stream_formats,
               *driver_selection_regex_list;

  // Array of spooling conversions, most desirables first
  //
  // Here we prefer not converting into another format
  // Keeping vector formats (like PS -> PDF) is usually more desirable
  // but as many printers have buggy PS interpreters we prefer converting
  // PDF to Raster and not to PS
  spooling_conversions = cupsArrayNew(NULL, NULL);

  // Special conversion rule for fxlinuxprint driver (Fuji Xerox
  // non-IPP-driverless PDF printers)
  cupsArrayAdd(spooling_conversions, &ghostscript_convert_pdf_to_fx_pdf);

  // Standard conversion rules
  cupsArrayAdd(spooling_conversions, (void *)&PR_CONVERT_PDF_TO_PDF);
  cupsArrayAdd(spooling_conversions, (void *)&PR_CONVERT_PDF_TO_RASTER);
  cupsArrayAdd(spooling_conversions, (void *)&PR_CONVERT_PDF_TO_PS);
  cupsArrayAdd(spooling_conversions, (void *)&PR_CONVERT_PS_TO_PS);
  cupsArrayAdd(spooling_conversions, (void *)&PR_CONVERT_PS_TO_PDF);
  cupsArrayAdd(spooling_conversions, (void *)&PR_CONVERT_PS_TO_RASTER);

  // Array of stream formats, most desirables first
  //
  // PDF comes last because it is generally not streamable.
  // PostScript comes second as it is Ghostscript's streamable
  // input format.
  stream_formats = cupsArrayNew(NULL, NULL);
  cupsArrayAdd(stream_formats, (void *)&PR_STREAM_CUPS_RASTER);
  cupsArrayAdd(stream_formats, (void *)&PR_STREAM_POSTSCRIPT);
  cupsArrayAdd(stream_formats, (void *)&PR_STREAM_PDF);

  // Array of regular expressions for driver priorization
  // For some printers the "(recommended)" is missing ...
  driver_selection_regex_list = cupsArrayNew(NULL, NULL);
  cupsArrayAdd(driver_selection_regex_list, "-recommended-");
  cupsArrayAdd(driver_selection_regex_list, "-pdf-");
  cupsArrayAdd(driver_selection_regex_list, "-postscript-");
  cupsArrayAdd(driver_selection_regex_list, "-pxlcolor-");
  cupsArrayAdd(driver_selection_regex_list, "-hpijs-pcl-5-c-");
  cupsArrayAdd(driver_selection_regex_list, "-cljet-5-");
  cupsArrayAdd(driver_selection_regex_list, "-pxl-");
  cupsArrayAdd(driver_selection_regex_list, "-pxlmono-");
  cupsArrayAdd(driver_selection_regex_list, "-lj-5-gray-");
  cupsArrayAdd(driver_selection_regex_list, "-lj-5-mono-");
  cupsArrayAdd(driver_selection_regex_list, "-hl-1250-");
  cupsArrayAdd(driver_selection_regex_list, "-hl-7-x-0-");
  cupsArrayAdd(driver_selection_regex_list, "-hpijs-pcl-5-e-");
  cupsArrayAdd(driver_selection_regex_list, "-pcl-5-");
  cupsArrayAdd(driver_selection_regex_list, "-ljet-4-d-");
  cupsArrayAdd(driver_selection_regex_list, "-ljet-4-");
  cupsArrayAdd(driver_selection_regex_list, "-lj-4-dith");
  cupsArrayAdd(driver_selection_regex_list, "-ljet-3-d-");
  cupsArrayAdd(driver_selection_regex_list, "-ljet-3-");
  cupsArrayAdd(driver_selection_regex_list, "-laserjet-");
  cupsArrayAdd(driver_selection_regex_list, "-ljet-2-p-");
  cupsArrayAdd(driver_selection_regex_list, "-ljetplus-");
  cupsArrayAdd(driver_selection_regex_list, "-pcl-3-");

  // Configuration record of the Printer Application
  pr_printer_app_config_t printer_app_config =
  {
    SYSTEM_NAME,              // Display name for Printer Application
    SYSTEM_PACKAGE_NAME,      // Package/executable name
    SYSTEM_VERSION_STR,       // Version as a string
    {
      SYSTEM_VERSION_ARR_0,   // Version 1st number
      SYSTEM_VERSION_ARR_1,   //         2nd
      SYSTEM_VERSION_ARR_2,   //         3rd
      SYSTEM_VERSION_ARR_3    //         4th
    },
    SYSTEM_WEB_IF_FOOTER,     // Footer for web interface (in HTML)
    PR_COPTIONS_QUERY_PS_DEFAULTS | // pappl-retrofit special features to be
    PR_COPTIONS_NO_GENERIC_DRIVER | // used
    PR_COPTIONS_NO_PAPPL_BACKENDS |
    PR_COPTIONS_CUPS_BACKENDS,
    ghostscript_autoadd,      // Auto-add (driver assignment) callback
    prIdentify,              // Printer identify callback
    prTestPage,              // Test page print callback
    ghostscript_system_setup, // Hide the log pages without a web interface
    ghostscript_printer_setup, // Set up "Device Settings" printer web
                              // interface page unless the web interface is off
    spooling_conversions,     // Array of data format conversion rules for
                              // printing in spooling mode
    stream_formats,           // Arrray for stream formats to be generated
                              // when printing in streaming mode
    "",                       // CUPS backends to be ignored
    "snmp,dnssd,usb",         // CUPS backends to be used exclusively
                              // If empty all but the ignored backends are used
    TESTPAGE,                 // Test page (printable file), used by the
                              // standard test print callback prTestPage()
    " +Foomatic/(.+)$| +(PDF|PXL|PCL5)$",
                              // Regular expression to separate the
                              // extra information after make/model in
                              // the PPD's *NickName. Also extracts a
                              // contained driver name (by using
                              // parentheses)
    driver_selection_regex_list
                              // Regular expression for the driver
                              // auto-selection to prioritize a driver
                              // when there is more than one for a
                              // given printer. If a regular
                              // expression matches on the driver
                              // name, the driver gets priority. If
                              // there is more than one matching
                              // driver, the driver name on which the
                              // earlier regular expression in the
                              // list matches, gets the priority.
  };

  return (prRetroFitPrinterApp(&printer_app_config, argc, argv));
}