search

NickNaso / ghostscript4js

Ghostscript4JS binds the Ghostscript C API to the Node.JS world.
http://www.nacios.it
Apache License 2.0
68 stars 19 forks source link
addon cplusplus ghostscript javascript native nodejs

readme

Ghostscript4JS

This module binds the Ghostscript C API to bring its power to the Node.JS world

Introduction

Ghostscript is a suite of software based on an interpreter for Adobe Systems' PostScript and Portable Document Format (PDF) page description languages. Its main purposes are the rasterization or rendering of such page description language files, for the display or printing of document pages, and the conversion between PostScript and PDF files.

Ghostscript can be used as a raster image processor (RIP) for raster computer printers—for instance, as an input filter of line printer daemon—or as the RIP engine behind PostScript and PDF viewers.

Ghostscript can also be used as a file format converter, such as PostScript to PDF converter. The ps2pdf conversion program, which comes with the ghostscript distribution, is described by its documentation as a "work-alike for nearly all the functionality (but not the user interface) of Adobe's Acrobat Distiller product".[3] This converter is basically a thin wrapper around ghostscript's pdfwrite output device, which supports PDF/A-1 and PDF/A-2 as well as PDF/X-3 output.[3]

Ghostscript can also serve as the back-end for PDF to raster image (png, tiff, jpeg, etc.) converter; this is often combined with a PostScript printer driver in "virtual printer" PDF creators.

As it takes the form of a language interpreter, Ghostscript can also be used as a general purpose programming environment.

Ghostscript has been ported to many operating systems, including Unix-like systems, classic Mac OS, OpenVMS, Microsoft Windows, Plan 9, MS-DOS, FreeDOS, OS/2, Atari TOS and AmigaOS.

More resource and info about Ghostscript

Motivations

At the time i created this module i was not able to find any module on npm that execute Ghostscript command through its C API, otherwise there were some module that call Ghostscript through the execution of the corresponding shell command. This is a good way to start using some library from node, but there are the following drawbacks:

To fit all needs Ghostscript4JS has sync and async methods so it could be used in a web application where it's very important to not block the event loop, so all requests will be served without any delay originated by our application.

Understanding Node.js event loop

Prerequisites

Before installing Ghostscript4JS you need to assure you have the following prerequisites:

At moment Ghostscript4JS is fully compatible with Ghostscript from version 9.19 to 9.50

Linux

Debian systems

Install Ghostscript

apt-get install ghostscript libgs-dev

At this point you need to set the enviroment variable GS4JS_HOME to /usr/lib/x86_64-linux-gnu

Red Hat | Fedora

yum install ghostscript ghostscript-devel

At this point you need to set the enviroment variable GS4JS_HOME to /usr/lib64 or /usr/lib based on you architecture

Arch Linux

pacman -S ghostscript

At this point you need to set the enviroment variable GS4JS_HOME to /usr/lib

Alpine

apk add ghostscript

At this point you need to set the enviroment variable GS4JS_HOME to /usr/lib

In general, based on your Linux OS and architecture, you have to set the environment variable GS4JS_HOME to point on folder containing libgs.so library.

Windows

macOS

brew install ghostscript

Official installation guide to install Ghostscript

Installation

If you want to use ghostscript4js you have to install it. There are two methods for that:

In dependencies of your package.json add the following item:

"ghostscript4js": "version"

then digit

npm install

Example:

"ghostscript4js": "*" for the latest version
"ghostscript4js": "1.0.0" for the version 1.0.0

OR

launch this command:

npm install ghostscript4js --save

Installation options

The module ghostscript4js allows you to use some installation options that you can use when in your operating system something is different against standard installation.

--GS4JS_HOME Set the GS4JS_HOME variable that represents the path in your system where is located the ghostscript library

Es. npm install ghostscript4js --GS4JS_HOME="C:/gs/bin"

--GS4JS_LIB Set the GS4JS_LIB variable that represents the file name for the ghostscript library installed in your system

Es. npm install ghostscript4js --GS4JS_LIB="libgs.so"

Only for Windows

--GS4JS_DLL Set the GS4JS_DLL variable that represents the file name for the ghostscript DLL installed in your windows system

Es. npm install ghostscript4js --GS4JS_DLL="gsdll64.dll"

Usage

'use strict'

const gs = require('ghostscript4js')

try {
  // Take decision based on Ghostscript version
  const version = gs.version()
  console.log(version)
  gs.executeSync('-sDEVICE=pngalpha -o my.png -sDEVICE=pngalpha -r144 my.pdf')
} catch (err) {
  // Handle error
  throw err
}

API

version

version() method returns an object that contains information about version of Ghostscript library installed on the system. It is important in those circumstances where you have to take decision based on different version. The returned data are similar to the example repoted below:

{
  product: "GPL Ghostscript",
  copyright: "Copyright (C) 2016 Artifex Software, Inc.  All rights reserved.",
  revision: 919,
  revisiondate: 20160323
}

This is a synchronous method and returns the version info or throws an Error to indicate that something went wrong during its execution.

Example - version

'use strict'

const gs = require('ghostscript4js')

try {
  const version = gs.version()
  console.log(version)
  // Take decision based on Ghostscript version
  if (version.revision > 916) {
    // ... some stuff
  } else {
    // ... other stuff
  }
} catch (err) {
  // Handle error
  throw err
}

executeSync

executeSync(cmd) method takes the Ghostscript command parameters in input as a string or array of strings and executes in a synchronous way. If something wrong happens in calling this method an Error with description and code error will be thrown.

Example - executeSync

'use strict'

const gs = require('ghostscript4js')

try {
  gs.executeSync('-sDEVICE=pngalpha -o my.png -sDEVICE=pngalpha -r144 my.pdf')
} catch (err) {
  // Handle error
  throw err
}

execute

execute(cmd, callback) method takes in input the Ghostscript command parameters as a string or array of strings and an optional callback. The execution will be asynchronous so this ensure better performance especially in a web application enviroment, because it'll not block the Node.Js event loop. This method has an optional callback function as input, in that case, a possible error will be handled by this function. If noone function will be provided the method returns a Promise that will be resolved or rejected as reported in the following example.

Example - execute

'use strict'

const gs = require('ghostscript4js')

let cmd = '-sDEVICE=pngalpha -o my.png -sDEVICE=pngalpha -r144 my.pdf'
gs.execute(cmd, function (err) {
  if (err) {
    console.log("Ooops... something wrong happened")
  }
})

'use strict'

const gs = require('ghostscript4js')

let cmd = '-sDEVICE=pngalpha -o my.png -sDEVICE=pngalpha -r144 my.pdf'
gs.execute(cmd)
.then(() => {
  console.log("All is ok")
})
.catch((err) => {
 console.log("Ooops... something wrong happened")
})

Error

The error raised from ghostscript4js in all of its method is an instance of Error object that cointains a message that describes what happened and at the same time cointains the Ghostscript error code so you can inspect what happened in a better way. At this link Ghostscript error codes you can find all Ghostscript errors code.

Min and Max supported revision

This module was built based on Ghostscript C API that is compatible with some specifics versions. The module has two properties MIN_SUPPORTED_REVISION and MAX_SUPPORTED_REVISION which respectively indicate the minimum and maximum supported Ghostscript's version.

Example - Min and Max supported revision

'use strict'

const gs = require('ghostscript4js')

console.log(gs.MIN_SUPPORTED_REVISION)
console.log(gs.MAX_SUPPORTED_REVISION)

Docker

Check out the example Dockerfile in examples/docker. It will create an image based on node 8.x and Debian stretch.

To build the image do:

cd examples/docker
docker build -t ghostscript4js .

Now you can run the image. By default it does npm start (which is node index.js) and exits.

docker run ghostscript4js

Running the container should output something like:

{ product: 'GPL Ghostscript',
  copyright: 'Copyright (C) 2016 Artifex Software, Inc.  All rights reserved.',
  revision: 920,
  revisiondate: 20160926 }

If you want to look around in the container you can get a shell like:

docker run -it ghostscript4js /bin/bash
gs --version

The Team

Nicola Del Gobbo

https://github.com/NickNaso/

https://www.npmjs.com/~nicknaso

https://twitter.com/NickNaso

Mauro Doganieri

https://github.com/mauro-d

https://www.npmjs.com/~mauro-d

https://twitter.com/maurodoganieri

Acknowledgements

Thank you to all people that encourage me every day.

License

Licensed under Apache license V2