okular/core/fileprinter.cpp
2023-12-13 10:27:13 +00:00

568 lines
20 KiB
C++

/*
SPDX-FileCopyrightText: 2007, 2010 John Layt <john@layt.net>
FilePrinterPreview based on KPrintPreview (originally LGPL)
SPDX-FileCopyrightText: 2007 Alex Merry <huntedhacker@tiscali.co.uk>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "fileprinter.h"
#include <QFile>
#include <QFileInfo>
#include <QLabel>
#include <QPrintEngine>
#include <QShowEvent>
#include <QSize>
#include <QStringList>
#include <QTcpSocket>
#include <KProcess>
#include <KShell>
#include <QDebug>
#include <QStandardPaths>
#include "debug_p.h"
using namespace Okular;
Document::PrintError
FilePrinter::printFile(QPrinter &printer, const QString &file, QPageLayout::Orientation documentOrientation, FileDeletePolicy fileDeletePolicy, PageSelectPolicy pageSelectPolicy, const QString &pageRange, ScaleMode scaleMode)
{
FilePrinter fp;
return fp.doPrintFiles(printer, QStringList(file), fileDeletePolicy, pageSelectPolicy, pageRange, documentOrientation, scaleMode);
}
static Document::PrintError doKProcessExecute(const QString &exe, const QStringList &argList)
{
const int ret = KProcess::execute(exe, argList);
if (ret == -1) {
return Document::PrintingProcessCrashPrintError;
}
if (ret == -2) {
return Document::PrintingProcessStartPrintError;
}
if (ret < 0) {
return Document::UnknownPrintError;
}
return Document::NoPrintError;
}
Document::PrintError
FilePrinter::doPrintFiles(QPrinter &printer, const QStringList &fileList, FileDeletePolicy fileDeletePolicy, PageSelectPolicy pageSelectPolicy, const QString &pageRange, QPageLayout::Orientation documentOrientation, ScaleMode scaleMode)
{
if (fileList.size() < 1) {
return Document::NoFileToPrintError;
}
for (QStringList::ConstIterator it = fileList.constBegin(); it != fileList.constEnd(); ++it) {
if (!QFile::exists(*it)) {
return Document::UnableToFindFilePrintError;
}
}
if (printer.printerState() == QPrinter::Aborted || printer.printerState() == QPrinter::Error) {
return Document::InvalidPrinterStatePrintError;
}
QString exe;
QStringList argList;
Document::PrintError ret;
// Print to File if a filename set, assumes there must be only 1 file
if (!printer.outputFileName().isEmpty()) {
if (QFile::exists(printer.outputFileName())) {
QFile::remove(printer.outputFileName());
}
QFileInfo inputFileInfo = QFileInfo(fileList[0]);
QFileInfo outputFileInfo = QFileInfo(printer.outputFileName());
bool doDeleteFile = (fileDeletePolicy == FilePrinter::SystemDeletesFiles);
if (inputFileInfo.suffix() == outputFileInfo.suffix()) {
if (doDeleteFile) {
bool res = QFile::rename(fileList[0], printer.outputFileName());
if (res) {
doDeleteFile = false;
ret = Document::NoPrintError;
} else {
ret = Document::PrintToFilePrintError;
}
} else {
bool res = QFile::copy(fileList[0], printer.outputFileName());
if (res) {
ret = Document::NoPrintError;
} else {
ret = Document::PrintToFilePrintError;
}
}
} else if (inputFileInfo.suffix() == QLatin1String("ps") && printer.outputFormat() == QPrinter::PdfFormat && ps2pdfAvailable()) {
exe = QStringLiteral("ps2pdf");
argList << fileList[0] << printer.outputFileName();
qCDebug(OkularCoreDebug) << "Executing" << exe << "with arguments" << argList;
ret = doKProcessExecute(exe, argList);
} else if (inputFileInfo.suffix() == QLatin1String("pdf") && printer.outputFormat() == QPrinter::NativeFormat && pdf2psAvailable()) {
exe = QStringLiteral("pdf2ps");
argList << fileList[0] << printer.outputFileName();
qCDebug(OkularCoreDebug) << "Executing" << exe << "with arguments" << argList;
ret = doKProcessExecute(exe, argList);
} else {
ret = Document::PrintToFilePrintError;
}
if (doDeleteFile) {
QFile::remove(fileList[0]);
}
} else { // Print to a printer via lpr command
// Decide what executable to use to print with, need the CUPS version of lpr if available
// Some distros name the CUPS version of lpr as lpr-cups or lpr.cups so try those first
// before default to lpr, or failing that to lp
if (!QStandardPaths::findExecutable(QStringLiteral("lpr-cups")).isEmpty()) {
exe = QStringLiteral("lpr-cups");
} else if (!QStandardPaths::findExecutable(QStringLiteral("lpr.cups")).isEmpty()) {
exe = QStringLiteral("lpr.cups");
} else if (!QStandardPaths::findExecutable(QStringLiteral("lpr")).isEmpty()) {
exe = QStringLiteral("lpr");
} else if (!QStandardPaths::findExecutable(QStringLiteral("lp")).isEmpty()) {
exe = QStringLiteral("lp");
} else {
return Document::NoBinaryToPrintError;
}
bool useCupsOptions = cupsAvailable();
argList = printArguments(printer, fileDeletePolicy, pageSelectPolicy, useCupsOptions, pageRange, exe, documentOrientation, scaleMode) << fileList;
qCDebug(OkularCoreDebug) << "Executing" << exe << "with arguments" << argList;
ret = doKProcessExecute(exe, argList);
}
return ret;
}
QList<int> FilePrinter::pageList(QPrinter &printer, int lastPage, int currentPage, const QList<int> &selectedPageList)
{
if (printer.printRange() == QPrinter::Selection) {
return selectedPageList;
}
int startPage, endPage;
QList<int> list;
if (printer.printRange() == QPrinter::PageRange) {
startPage = printer.fromPage();
endPage = printer.toPage();
} else if (printer.printRange() == QPrinter::CurrentPage) {
startPage = currentPage;
endPage = currentPage;
} else { // AllPages
startPage = 1;
endPage = lastPage;
}
for (int i = startPage; i <= endPage; i++) {
list << i;
}
return list;
}
bool FilePrinter::ps2pdfAvailable()
{
return (!QStandardPaths::findExecutable(QStringLiteral("ps2pdf")).isEmpty());
}
bool FilePrinter::pdf2psAvailable()
{
return (!QStandardPaths::findExecutable(QStringLiteral("pdf2ps")).isEmpty());
}
bool FilePrinter::cupsAvailable()
{
#if defined(Q_OS_UNIX) && !defined(Q_OS_OSX)
// Ideally we would have access to the private Qt method
// QCUPSSupport::cupsAvailable() to do this as it is very complex routine.
// However, if CUPS is available then QPrinter::supportsMultipleCopies() will always return true
// whereas if CUPS is not available it will return false.
// This behaviour is guaranteed never to change, so we can use it as a reliable substitute.
QPrinter testPrinter;
return testPrinter.supportsMultipleCopies();
#else
return false;
#endif
}
QStringList FilePrinter::printArguments(QPrinter &printer,
FileDeletePolicy fileDeletePolicy,
PageSelectPolicy pageSelectPolicy,
bool useCupsOptions,
const QString &pageRange,
const QString &version,
QPageLayout::Orientation documentOrientation,
ScaleMode scaleMode)
{
QStringList argList;
if (!destination(printer, version).isEmpty()) {
argList << destination(printer, version);
}
if (!copies(printer, version).isEmpty()) {
argList << copies(printer, version);
}
if (!jobname(printer, version).isEmpty()) {
argList << jobname(printer, version);
}
if (!pages(printer, pageSelectPolicy, pageRange, useCupsOptions, version).isEmpty()) {
argList << pages(printer, pageSelectPolicy, pageRange, useCupsOptions, version);
}
if (useCupsOptions && !cupsOptions(printer, documentOrientation, scaleMode).isEmpty()) {
argList << cupsOptions(printer, documentOrientation, scaleMode);
}
if (!deleteFile(printer, fileDeletePolicy, version).isEmpty()) {
argList << deleteFile(printer, fileDeletePolicy, version);
}
if (version == QLatin1String("lp")) {
argList << QStringLiteral("--");
}
return argList;
}
QStringList FilePrinter::destination(QPrinter &printer, const QString &version)
{
if (version == QLatin1String("lp")) {
return QStringList(QStringLiteral("-d")) << printer.printerName();
}
if (version.startsWith(QLatin1String("lpr"))) {
return QStringList(QStringLiteral("-P")) << printer.printerName();
}
return QStringList();
}
QStringList FilePrinter::copies(QPrinter &printer, const QString &version)
{
int cp = printer.copyCount();
if (version == QLatin1String("lp")) {
return QStringList(QStringLiteral("-n")) << QStringLiteral("%1").arg(cp);
}
if (version.startsWith(QLatin1String("lpr"))) {
return QStringList() << QStringLiteral("-#%1").arg(cp);
}
return QStringList();
}
QStringList FilePrinter::jobname(QPrinter &printer, const QString &version)
{
if (!printer.docName().isEmpty()) {
if (version == QLatin1String("lp")) {
return QStringList(QStringLiteral("-t")) << printer.docName();
}
if (version.startsWith(QLatin1String("lpr"))) {
const QString shortenedDocName = QString::fromUtf8(printer.docName().toUtf8().left(255));
return QStringList(QStringLiteral("-J")) << shortenedDocName;
}
}
return QStringList();
}
QStringList FilePrinter::deleteFile(QPrinter &, FileDeletePolicy fileDeletePolicy, const QString &version)
{
if (fileDeletePolicy == FilePrinter::SystemDeletesFiles && version.startsWith(QLatin1String("lpr"))) {
return QStringList(QStringLiteral("-r"));
}
return QStringList();
}
QStringList FilePrinter::pages(QPrinter &printer, PageSelectPolicy pageSelectPolicy, const QString &pageRange, bool useCupsOptions, const QString &version)
{
if (pageSelectPolicy == FilePrinter::SystemSelectsPages) {
if (printer.printRange() == QPrinter::Selection && !pageRange.isEmpty()) {
if (version == QLatin1String("lp")) {
return QStringList(QStringLiteral("-P")) << pageRange;
}
if (version.startsWith(QLatin1String("lpr")) && useCupsOptions) {
return QStringList(QStringLiteral("-o")) << QStringLiteral("page-ranges=%1").arg(pageRange);
}
}
if (printer.printRange() == QPrinter::PageRange) {
if (version == QLatin1String("lp")) {
return QStringList(QStringLiteral("-P")) << QStringLiteral("%1-%2").arg(printer.fromPage()).arg(printer.toPage());
}
if (version.startsWith(QLatin1String("lpr")) && useCupsOptions) {
return QStringList(QStringLiteral("-o")) << QStringLiteral("page-ranges=%1-%2").arg(printer.fromPage()).arg(printer.toPage());
}
}
}
return QStringList(); // AllPages
}
QStringList FilePrinter::cupsOptions(QPrinter &printer, QPageLayout::Orientation documentOrientation, ScaleMode scaleMode)
{
QStringList optionList;
if (!optionMedia(printer).isEmpty()) {
optionList << optionMedia(printer);
}
if (!optionOrientation(printer, documentOrientation).isEmpty()) {
optionList << optionOrientation(printer, documentOrientation);
}
if (!optionDoubleSidedPrinting(printer).isEmpty()) {
optionList << optionDoubleSidedPrinting(printer);
}
if (!optionPageOrder(printer).isEmpty()) {
optionList << optionPageOrder(printer);
}
if (!optionCollateCopies(printer).isEmpty()) {
optionList << optionCollateCopies(printer);
}
if (!optionPageMargins(printer, scaleMode).isEmpty()) {
optionList << optionPageMargins(printer, scaleMode);
}
optionList << optionCupsProperties(printer);
return optionList;
}
QStringList FilePrinter::optionMedia(QPrinter &printer)
{
if (!mediaPageSize(printer).isEmpty() && !mediaPaperSource(printer).isEmpty()) {
return QStringList(QStringLiteral("-o")) << QStringLiteral("media=%1,%2").arg(mediaPageSize(printer), mediaPaperSource(printer));
}
if (!mediaPageSize(printer).isEmpty()) {
return QStringList(QStringLiteral("-o")) << QStringLiteral("media=%1").arg(mediaPageSize(printer));
}
if (!mediaPaperSource(printer).isEmpty()) {
return QStringList(QStringLiteral("-o")) << QStringLiteral("media=%1").arg(mediaPaperSource(printer));
}
return QStringList();
}
QString FilePrinter::mediaPageSize(QPrinter &printer)
{
switch (printer.pageLayout().pageSize().id()) {
case QPageSize::A0:
return QStringLiteral("A0");
case QPageSize::A1:
return QStringLiteral("A1");
case QPageSize::A2:
return QStringLiteral("A2");
case QPageSize::A3:
return QStringLiteral("A3");
case QPageSize::A4:
return QStringLiteral("A4");
case QPageSize::A5:
return QStringLiteral("A5");
case QPageSize::A6:
return QStringLiteral("A6");
case QPageSize::A7:
return QStringLiteral("A7");
case QPageSize::A8:
return QStringLiteral("A8");
case QPageSize::A9:
return QStringLiteral("A9");
case QPageSize::B0:
return QStringLiteral("B0");
case QPageSize::B1:
return QStringLiteral("B1");
case QPageSize::B10:
return QStringLiteral("B10");
case QPageSize::B2:
return QStringLiteral("B2");
case QPageSize::B3:
return QStringLiteral("B3");
case QPageSize::B4:
return QStringLiteral("B4");
case QPageSize::B5:
return QStringLiteral("B5");
case QPageSize::B6:
return QStringLiteral("B6");
case QPageSize::B7:
return QStringLiteral("B7");
case QPageSize::B8:
return QStringLiteral("B8");
case QPageSize::B9:
return QStringLiteral("B9");
case QPageSize::C5E:
return QStringLiteral("C5"); // Correct Translation?
case QPageSize::Comm10E:
return QStringLiteral("Comm10"); // Correct Translation?
case QPageSize::DLE:
return QStringLiteral("DL"); // Correct Translation?
case QPageSize::Executive:
return QStringLiteral("Executive");
case QPageSize::Folio:
return QStringLiteral("Folio");
case QPageSize::Ledger:
return QStringLiteral("Ledger");
case QPageSize::Legal:
return QStringLiteral("Legal");
case QPageSize::Letter:
return QStringLiteral("Letter");
case QPageSize::Tabloid:
return QStringLiteral("Tabloid");
case QPageSize::Custom:
return QStringLiteral("Custom.%1x%2mm").arg(printer.widthMM()).arg(printer.heightMM());
default:
return QString();
}
}
// What about Upper and MultiPurpose? And others in PPD???
QString FilePrinter::mediaPaperSource(QPrinter &printer)
{
switch (printer.paperSource()) {
case QPrinter::Auto:
return QString();
case QPrinter::Cassette:
return QStringLiteral("Cassette");
case QPrinter::Envelope:
return QStringLiteral("Envelope");
case QPrinter::EnvelopeManual:
return QStringLiteral("EnvelopeManual");
case QPrinter::FormSource:
return QStringLiteral("FormSource");
case QPrinter::LargeCapacity:
return QStringLiteral("LargeCapacity");
case QPrinter::LargeFormat:
return QStringLiteral("LargeFormat");
case QPrinter::Lower:
return QStringLiteral("Lower");
case QPrinter::MaxPageSource:
return QStringLiteral("MaxPageSource");
case QPrinter::Middle:
return QStringLiteral("Middle");
case QPrinter::Manual:
return QStringLiteral("Manual");
case QPrinter::OnlyOne:
return QStringLiteral("OnlyOne");
case QPrinter::Tractor:
return QStringLiteral("Tractor");
case QPrinter::SmallFormat:
return QStringLiteral("SmallFormat");
default:
return QString();
}
}
QStringList FilePrinter::optionOrientation(QPrinter &printer, QPageLayout::Orientation documentOrientation)
{
// portrait and landscape options rotate the document according to the document orientation
// If we want to print a landscape document as one would expect it, we have to pass the
// portrait option so that the document is not rotated additionally
if (printer.pageLayout().orientation() == documentOrientation) {
// the user wants the document printed as is
return QStringList(QStringLiteral("-o")) << QStringLiteral("portrait");
} else {
// the user expects the document being rotated by 90 degrees
return QStringList(QStringLiteral("-o")) << QStringLiteral("landscape");
}
}
QStringList FilePrinter::optionDoubleSidedPrinting(QPrinter &printer)
{
switch (printer.duplex()) {
case QPrinter::DuplexNone:
return QStringList(QStringLiteral("-o")) << QStringLiteral("sides=one-sided");
case QPrinter::DuplexAuto:
if (printer.pageLayout().orientation() == QPageLayout::Landscape) {
return QStringList(QStringLiteral("-o")) << QStringLiteral("sides=two-sided-short-edge");
} else {
return QStringList(QStringLiteral("-o")) << QStringLiteral("sides=two-sided-long-edge");
}
case QPrinter::DuplexLongSide:
return QStringList(QStringLiteral("-o")) << QStringLiteral("sides=two-sided-long-edge");
case QPrinter::DuplexShortSide:
return QStringList(QStringLiteral("-o")) << QStringLiteral("sides=two-sided-short-edge");
default:
return QStringList(); // Use printer default
}
}
QStringList FilePrinter::optionPageOrder(QPrinter &printer)
{
if (printer.pageOrder() == QPrinter::LastPageFirst) {
return QStringList(QStringLiteral("-o")) << QStringLiteral("outputorder=reverse");
}
return QStringList(QStringLiteral("-o")) << QStringLiteral("outputorder=normal");
}
QStringList FilePrinter::optionCollateCopies(QPrinter &printer)
{
if (printer.collateCopies()) {
return QStringList(QStringLiteral("-o")) << QStringLiteral("Collate=True");
}
return QStringList(QStringLiteral("-o")) << QStringLiteral("Collate=False");
}
QStringList FilePrinter::optionPageMargins(QPrinter &printer, ScaleMode scaleMode)
{
if (printer.printEngine()->property(QPrintEngine::PPK_PageMargins).isNull()) {
return QStringList();
} else {
qreal l(0), t(0), r(0), b(0);
if (!printer.fullPage()) {
auto marginsf = printer.pageLayout().margins(QPageLayout::Point);
l = marginsf.left();
t = marginsf.top();
r = marginsf.right();
b = marginsf.bottom();
}
QStringList marginOptions;
marginOptions << (QStringLiteral("-o")) << QStringLiteral("page-left=%1").arg(l) << QStringLiteral("-o") << QStringLiteral("page-top=%1").arg(t) << QStringLiteral("-o") << QStringLiteral("page-right=%1").arg(r)
<< QStringLiteral("-o") << QStringLiteral("page-bottom=%1").arg(b);
if (scaleMode == ScaleMode::FitToPrintArea) {
marginOptions << QStringLiteral("-o") << QStringLiteral("fit-to-page");
}
return marginOptions;
}
}
QStringList FilePrinter::optionCupsProperties(QPrinter &printer)
{
QStringList dialogOptions = printer.printEngine()->property(QPrintEngine::PrintEnginePropertyKey(0xfe00)).toStringList();
QStringList cupsOptions;
for (int i = 0; i < dialogOptions.count(); i = i + 2) {
if (dialogOptions[i + 1].isEmpty()) {
cupsOptions << QStringLiteral("-o") << dialogOptions[i];
} else {
cupsOptions << QStringLiteral("-o") << dialogOptions[i] + QLatin1Char('=') + dialogOptions[i + 1];
}
}
return cupsOptions;
}
/* kate: replace-tabs on; indent-width 4; */