okular/generators/dvi/psgs.cpp
Glen Kaukola 6623fcd4d8 Fix for the dvi generator issue with .eps files that have non-latin characters in the path.
Fix only in KDE > 4.5.
BUG: 228551

svn path=/trunk/KDE/kdegraphics/okular/; revision=1107836
2010-03-26 23:47:53 +00:00

357 lines
11 KiB
C++

// -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; c-brace-offset: 0; -*-
//
// ghostscript_interface
//
// Part of KDVI - A framework for multipage text/gfx viewers
//
// (C) 2004 Stefan Kebekus
// Distributed under the GPL
#include <config.h>
#include "psgs.h"
#include "psheader.cpp"
#include "dviFile.h"
#include "kvs_debug.h"
#include "pageNumber.h"
#include <klocale.h>
#include <kmessagebox.h>
#include <kprocess.h>
#include <ktemporaryfile.h>
#include <kurl.h>
#include <QDir>
#include <QPainter>
#include <QPixmap>
#include <QTextStream>
#include <QTimer>
//#define DEBUG_PSGS
//extern char psheader[];
pageInfo::pageInfo(const QString& _PostScriptString) {
PostScriptString = new QString(_PostScriptString);
background = Qt::white;
permanentBackground = Qt::white;
}
pageInfo::~pageInfo() {
if (PostScriptString != 0L)
delete PostScriptString;
}
// ======================================================
ghostscript_interface::ghostscript_interface() {
PostScriptHeaderString = new QString();
knownDevices.append("png16m");
knownDevices.append("jpeg");
knownDevices.append("pnn");
knownDevices.append("pnnraw");
gsDevice = knownDevices.begin();
}
ghostscript_interface::~ghostscript_interface() {
if (PostScriptHeaderString != 0L)
delete PostScriptHeaderString;
qDeleteAll(pageList);
}
void ghostscript_interface::setPostScript(const PageNumber& page, const QString& PostScript) {
#ifdef DEBUG_PSGS
kDebug(kvs::dvi) << "ghostscript_interface::setPostScript( " << page << ", ... )";
#endif
if (pageList.value(page) == 0) {
pageInfo *info = new pageInfo(PostScript);
// Check if dict is big enough
if (pageList.count() > pageList.capacity() -2)
pageList.reserve(pageList.capacity()*2);
pageList.insert(page, info);
} else
*(pageList.value(page)->PostScriptString) = PostScript;
}
void ghostscript_interface::setIncludePath(const QString &_includePath) {
if (_includePath.isEmpty())
includePath = "*"; // Allow all files
else
includePath = _includePath+"/*";
}
void ghostscript_interface::setBackgroundColor(const PageNumber& page, const QColor& background_color, bool permanent) {
#ifdef DEBUG_PSGS
kDebug(kvs::dvi) << "ghostscript_interface::setBackgroundColor( " << page << ", " << background_color << " )";
#endif
if (pageList.value(page) == 0) {
pageInfo *info = new pageInfo(QString::null); //krazy:exclude=nullstrassign for old broken gcc
info->background = background_color;
if (permanent)
info->permanentBackground = background_color;
// Check if dict is big enough
if (pageList.count() > pageList.capacity() -2)
pageList.reserve(pageList.capacity()*2);
pageList.insert(page, info);
} else {
pageList.value(page)->background = background_color;
if (permanent)
pageList.value(page)->permanentBackground = background_color;
}
}
void ghostscript_interface::restoreBackgroundColor(const PageNumber& page)
{
#ifdef DEBUG_PSGS
kDebug(kvs::dvi) << "ghostscript_interface::restoreBackgroundColor( " << page << " )";
#endif
if (pageList.value(page) == 0)
return;
pageInfo *info = pageList.value(page);
info->background = info->permanentBackground;
}
// Returns the background color for a certain page. This color is
// always guaranteed to be valid
QColor ghostscript_interface::getBackgroundColor(const PageNumber& page) const {
#ifdef DEBUG_PSGS
kDebug(kvs::dvi) << "ghostscript_interface::getBackgroundColor( " << page << " )";
#endif
if (pageList.value(page) == 0)
return Qt::white;
else
return pageList.value(page)->background;
}
void ghostscript_interface::clear() {
PostScriptHeaderString->truncate(0);
// Deletes all items, removes temporary files, etc.
qDeleteAll(pageList);
pageList.clear();
}
void ghostscript_interface::gs_generate_graphics_file(const PageNumber& page, const QString& filename, long magnification) {
#ifdef DEBUG_PSGS
kDebug(kvs::dvi) << "ghostscript_interface::gs_generate_graphics_file( " << page << ", " << filename << " )";
#endif
if (knownDevices.isEmpty()) {
kError(kvs::dvi) << "No known devices found" << endl;
return;
}
pageInfo *info = pageList.value(page);
// Generate a PNG-file
// Step 1: Write the PostScriptString to a File
KTemporaryFile PSfile;
PSfile.setAutoRemove(false);
PSfile.setSuffix(".ps");
PSfile.open();
const QString PSfileName = PSfile.fileName();
QTextStream os(&PSfile);
os << "%!PS-Adobe-2.0\n"
<< "%%Creator: kdvi\n"
<< "%%Title: KDVI temporary PostScript\n"
<< "%%Pages: 1\n"
<< "%%PageOrder: Ascend\n"
// HSize and VSize in 1/72 inch
<< "%%BoundingBox: 0 0 "
<< (qint32)(72*(pixel_page_w/resolution)) << ' '
<< (qint32)(72*(pixel_page_h/resolution)) << '\n'
<< "%%EndComments\n"
<< "%!\n"
<< psheader
<< "TeXDict begin "
// HSize in (1/(65781.76*72))inch
<< (qint32)(72*65781*(pixel_page_w/resolution)) << ' '
// VSize in (1/(65781.76*72))inch
<< (qint32)(72*65781*(pixel_page_h/resolution)) << ' '
// Magnification
<< (qint32)(magnification)
// dpi and vdpi
<< " 300 300"
// Name
<< " (test.dvi)"
<< " @start end\n"
<< "TeXDict begin\n"
// Start page
<< "1 0 bop 0 0 a \n";
if (!PostScriptHeaderString->toLatin1().isNull())
os << PostScriptHeaderString->toLatin1();
if (info->background != Qt::white) {
QString colorCommand = QString("gsave %1 %2 %3 setrgbcolor clippath fill grestore\n").
arg(info->background.red()/255.0).
arg(info->background.green()/255.0).
arg(info->background.blue()/255.0);
os << colorCommand.toLatin1();
}
if (!info->PostScriptString->isNull())
os << *(info->PostScriptString);
os << "end\n"
<< "showpage \n";
PSfile.close();
// Step 2: Call GS with the File
QFile::remove(filename.toAscii());
KProcess proc;
proc.setOutputChannelMode(KProcess::SeparateChannels);
QStringList argus;
argus << "gs";
argus << "-dSAFER" << "-dPARANOIDSAFER" << "-dDELAYSAFER" << "-dNOPAUSE" << "-dBATCH";
argus << QString("-sDEVICE=%1").arg(*gsDevice);
argus << QString("-sOutputFile=%1").arg(filename);
argus << QString("-sExtraIncludePath=%1").arg(includePath);
argus << QString("-g%1x%2").arg(pixel_page_w).arg(pixel_page_h); // page size in pixels
argus << QString("-r%1").arg(resolution); // resolution in dpi
argus << "-dTextAlphaBits=4 -dGraphicsAlphaBits=2"; // Antialiasing
argus << "-c" << "<< /PermitFileReading [ ExtraIncludePath ] /PermitFileWriting [] /PermitFileControl [] >> setuserparams .locksafe";
argus << "-f" << PSfileName;
#ifdef DEBUG_PSGS
kDebug(kvs::dvi) << argus.join(" ");
#endif
proc << argus;
int res = proc.execute();
if ( res ) {
// Starting ghostscript did not work.
// TODO: Issue error message, switch PS support off.
kError(kvs::dvi) << "ghostview could not be started" << endl;
}
PSfile.remove();
// Check if gs has indeed produced a file.
if (QFile::exists(filename) == false) {
kError(kvs::dvi) << "GS did not produce output." << endl;
// No. Check is the reason is that the device is not compiled into
// ghostscript. If so, try again with another device.
QString GSoutput;
proc.setReadChannel(QProcess::StandardOutput);
while(proc.canReadLine()) {
GSoutput = QString::fromLocal8Bit(proc.readLine());
if (GSoutput.contains("Unknown device")) {
kDebug(kvs::dvi) << QString("The version of ghostview installed on this computer does not support "
"the '%1' ghostview device driver.").arg(*gsDevice) << endl;
knownDevices.erase(gsDevice);
gsDevice = knownDevices.begin();
if (knownDevices.isEmpty())
// TODO: show a requestor of some sort.
#if 0
KMessageBox::detailedError(0,
i18n("<qt>The version of Ghostview that is installed on this computer does not contain "
"any of the Ghostview device drivers that are known to Okular. PostScript "
"support has therefore been turned off in Okular.</qt>"),
i18n("<qt><p>The Ghostview program, which Okular uses internally to display the "
"PostScript graphics that is included in this DVI file, is generally able to "
"write its output in a variety of formats. The sub-programs that Ghostview uses "
"for these tasks are called 'device drivers'; there is one device driver for "
"each format that Ghostview is able to write. Different versions of Ghostview "
"often have different sets of device drivers available. It seems that the "
"version of Ghostview that is installed on this computer does not contain "
"<strong>any</strong> of the device drivers that are known to Okular.</p>"
"<p>It seems unlikely that a regular installation of Ghostview would not contain "
"these drivers. This error may therefore point to a serious misconfiguration of "
"the Ghostview installation on your computer.</p>"
"<p>If you want to fix the problems with Ghostview, you can use the command "
"<strong>gs --help</strong> to display the list of device drivers contained in "
"Ghostview. Among others, Okular can use the 'png256', 'jpeg' and 'pnm' "
"drivers. Note that Okular needs to be restarted to re-enable PostScript support."
"</p></qt>"));
#else
{}
#endif
else {
kDebug(kvs::dvi) << QString("Okular will now try to use the '%1' device driver.").arg(*gsDevice);
gs_generate_graphics_file(page, filename, magnification);
}
return;
}
}
}
}
void ghostscript_interface::graphics(const PageNumber& page, double dpi, long magnification, QPainter* paint) {
#ifdef DEBUG_PSGS
kDebug(kvs::dvi) << "ghostscript_interface::graphics( " << page << ", " << dpi << ", ... ) called.";
#endif
if (paint == 0) {
kError(kvs::dvi) << "ghostscript_interface::graphics(PageNumber page, double dpi, long magnification, QPainter *paint) called with paint == 0" << endl;
return;
}
resolution = dpi;
pixel_page_w = paint->viewport().width();
pixel_page_h = paint->viewport().height();
pageInfo *info = pageList.value(page);
// No PostScript? Then return immediately.
if ((info == 0) || (info->PostScriptString->isEmpty())) {
#ifdef DEBUG_PSGS
kDebug(kvs::dvi) << "No PostScript found. Not drawing anything.";
#endif
return;
}
QTemporaryFile gfxFile;
gfxFile.open();
const QString gfxFileName = gfxFile.fileName();
// We are want the filename, not the file.
gfxFile.close();
gs_generate_graphics_file(page, gfxFileName, magnification);
QImage MemoryCopy(gfxFileName);
paint->drawImage(0, 0, MemoryCopy);
return;
}
QString ghostscript_interface::locateEPSfile(const QString &filename, const KUrl &base)
{
// If the base URL indicates that the DVI file is local, try to find
// the graphics file in the directory where the DVI file resides
if (base.isLocalFile()) {
QString path = base.path(); // -> "/bar/foo.dvi"
QFileInfo fi1(path);
QFileInfo fi2(fi1.dir(),filename);
if (fi2.exists())
return fi2.absoluteFilePath();
}
// Otherwise, use kpsewhich to find the eps file.
KProcess proc;
proc << "kpsewhich" << filename;
proc.execute();
return QString::fromLocal8Bit(proc.readLine().trimmed());
}
#include "psgs.moc"