kprinterimpl.cpp

/*
 *  This file is part of the KDE libraries
 *  Copyright (c) 2001 Michael Goffioul <tdeprint@swing.be>
 *
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License version 2 as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 **/
 
#include "kprinterimpl.h"
#include "kprinter.h"
#include "kmfactory.h"
#include "kmmanager.h"
#include "kmuimanager.h"
#include "kxmlcommand.h"
#include "kmspecialmanager.h"
#include "kmthreadjob.h"
#include "kmprinter.h"
#include "driver.h"
 
#include <tqfile.h>
#include <tqregexp.h>
#include <kinputdialog.h>
#include <tdelocale.h>
#include <dcopclient.h>
#include <tdeapplication.h>
#include <tdestandarddirs.h>
#include <kdatastream.h>
#include <kdebug.h>
#include <kmimemagic.h>
#include <tdemessagebox.h>
#include <tdeprocess.h>
#include <tdeconfig.h>
 
#include <stdlib.h>
 
void dumpOptions(const TQMap<TQString,TQString>&);
void initEditPrinter(KMPrinter *p)
{
    if (!p->isEdited())
    {
        p->setEditedOptions(p->defaultOptions());
        p->setEdited(true);
    }
}
 
//****************************************************************************************
 
KPrinterImpl::KPrinterImpl(TQObject *parent, const char *name)
: TQObject(parent,name)
{
    loadAppOptions();
}
 
KPrinterImpl::~KPrinterImpl()
{
}
 
void KPrinterImpl::preparePrinting(KPrinter *printer)
{
    // page size -> try to find page size and margins from driver file
    // use "PageSize" as option name to find the wanted page size. It's
    // up to the driver loader to use that option name.
    KMManager   *mgr = KMFactory::self()->manager();
    DrMain  *driver = mgr->loadPrinterDriver(mgr->findPrinter(printer->printerName()), false);
    if (driver)
    {
        // Find the page size:
        // 1) print option
        // 2) default driver option
        TQString    psname = printer->option("PageSize");
        if (psname.isEmpty())
        {
            DrListOption    *opt = (DrListOption*)driver->findOption("PageSize");
            if (opt) psname = opt->get("default");
        }
        if (!psname.isEmpty())
        {
            printer->setOption("kde-pagesize",TQString::number((int)pageNameToPageSize(psname)));
            DrPageSize  *ps = driver->findPageSize(psname);
            if (ps)
            {
                printer->setRealPageSize( ps );
            }
        }
 
        // Find the numerical resolution
        // 1) print option (Resolution)
        // 2) default driver option (Resolution)
        // 3) default printer resolution
        // The resolution must have the format: XXXdpi or XXXxYYYdpi. In the second
        // case the YYY value is used as resolution.
        TQString res = printer->option( "Resolution" );
        if ( res.isEmpty() )
        {
            DrBase *opt = driver->findOption( "Resolution" );
            if ( opt )
                res = opt->get( "default" );
            if ( res.isEmpty() )
                res = driver->get( "resolution" );
        }
        if ( !res.isEmpty() )
        {
            TQRegExp re( "(\\d+)(?:x(\\d+))?dpi" );
            if ( re.search( res ) != -1 )
            {
                if ( !re.cap( 2 ).isEmpty() )
                    printer->setOption( "kde-resolution", re.cap( 2 ) );
                else
                    printer->setOption( "kde-resolution", re.cap( 1 ) );
            }
        }
 
        // Find the supported fonts
        TQString fonts = driver->get( "fonts" );
        if ( !fonts.isEmpty() )
            printer->setOption( "kde-fonts", fonts );
 
        delete driver;
    }
 
}
 
bool KPrinterImpl::setupCommand(TQString&, KPrinter*)
{
    return false;
}
 
bool KPrinterImpl::printFiles(KPrinter *p, const TQStringList& f, bool flag)
{
    TQString    cmd;
    if (p->option("kde-isspecial") == "1")
    {
        if (p->option("kde-special-command").isEmpty() && p->outputToFile())
        {
            KURL url( p->outputFileName() );
            if ( !url.isLocalFile() )
            {
                cmd = ( flag ? "mv" : "cp" ) + ( " %in $out{" + p->outputFileName() + "}" );
            }
            else
            {
                if (f.count() > 1)
                {
                    p->setErrorMessage(i18n("Cannot copy multiple files into one file."));
                    return false;
                }
                else
                {
                    TDEProcess proc;
                    proc << (flag?"mv":"cp") << f[0] << p->outputFileName();
                    if (!proc.start(TDEProcess::Block) || !proc.normalExit() || proc.exitStatus() != 0)
                    {
                        p->setErrorMessage(i18n("Cannot save print file to %1. Check that you have write access to it.").arg(p->outputFileName()));
                        return false;
                    }
                }
                return true;
            }
        }
        else if (!setupSpecialCommand(cmd,p,f))
            return false;
    }
    else if (!setupCommand(cmd,p))
        return false;
    return startPrinting(cmd,p,f,flag);
}
 
void KPrinterImpl::broadcastOption(const TQString& key, const TQString& value)
{
    // force printer listing if not done yet (or reload needed)
    TQPtrList<KMPrinter>    *printers = KMFactory::self()->manager()->printerListComplete(false);
    if (printers)
    {
        TQPtrListIterator<KMPrinter>    it(*printers);
        for (;it.current();++it)
        {
            initEditPrinter(it.current());
            it.current()->setEditedOption(key,value);
        }
    }
}
 
int KPrinterImpl::dcopPrint(const TQString& cmd, const TQStringList& files, bool removeflag)
{
    kdDebug(500) << "tdeprint: print command: " << cmd << endl;
 
    int result = 0;
    DCOPClient  *dclient = tdeApp->dcopClient();
    if (!dclient || (!dclient->isAttached() && !dclient->attach()))
    {
        return result;
    }
 
    TQByteArray data, replyData;
    TQCString replyType;
    TQDataStream arg( data, IO_WriteOnly );
    arg << cmd;
    arg << files;
    arg << removeflag;
    if (dclient->call( "kded", "tdeprintd", "print(TQString,TQStringList,bool)", data, replyType, replyData ))
    {
        if (replyType == "int")
        {
            TQDataStream _reply_stream( replyData, IO_ReadOnly );
            _reply_stream >> result;
        }
    }
    return result;
}
 
void KPrinterImpl::statusMessage(const TQString& msg, KPrinter *printer)
{
    kdDebug(500) << "tdeprint: status message: " << msg << endl;
    TDEConfig   *conf = KMFactory::self()->printConfig();
    conf->setGroup("General");
    if (!conf->readBoolEntry("ShowStatusMsg", true))
        return;
 
    TQString    message(msg);
    if (printer && !msg.isEmpty())
        message.prepend(i18n("Printing document: %1").arg(printer->docName())+"\n");
 
    DCOPClient  *dclient = tdeApp->dcopClient();
    if (!dclient || (!dclient->isAttached() && !dclient->attach()))
    {
        return;
    }
 
    TQByteArray data;
    TQDataStream arg( data, IO_WriteOnly );
    arg << message;
    arg << (int)getpid();
    arg << tdeApp->caption();
    dclient->send( "kded", "tdeprintd", "statusMessage(TQString,int,TQString)", data );
}
 
bool KPrinterImpl::startPrinting(const TQString& cmd, KPrinter *printer, const TQStringList& files, bool flag)
{
    statusMessage(i18n("Sending print data to printer: %1").arg(printer->printerName()), printer);
 
    TQString    command(cmd), filestr;
    TQStringList    printfiles;
    if (command.find("%in") == -1) command.append(" %in");
 
    for (TQStringList::ConstIterator it=files.begin(); it!=files.end(); ++it)
        if (TQFile::exists(*it))
        {
            // quote filenames
            filestr.append(quote(*it)).append(" ");
            printfiles.append(*it);
        }
        else
            kdDebug(500) << "File not found: " << (*it) << endl;
 
    if (printfiles.count() > 0)
    {
        command.replace("%in",filestr);
        int pid = dcopPrint(command,files,flag);
        if (pid > 0)
        {
            if (printer)
                KMThreadJob::createJob(pid,printer->printerName(),printer->docName(),getenv("USER"),0);
            return true;
        }
        else
        {
            TQString    msg = i18n("Unable to start child print process. ");
            if (pid == 0)
                msg += i18n("The TDE print server (<b>tdeprintd</b>) could not be contacted. Check that this server is running.");
            else
                msg += i18n("1 is the command that <files> is given to", "Check the command syntax:\n%1 <files>").arg(cmd);
            printer->setErrorMessage(msg);
            return false;
        }
    }
    //else
    //{
        printer->setErrorMessage(i18n("No valid file was found for printing. Operation aborted."));
        return false;
    //}
}
 
TQString KPrinterImpl::tempFile()
{
    TQString    f;
    // be sure the file doesn't exist
    do f = locateLocal("tmp","tdeprint_") + TDEApplication::randomString(8); while (TQFile::exists(f));
    return f;
}
 
int KPrinterImpl::filterFiles(KPrinter *printer, TQStringList& files, bool flag)
{
    TQStringList    flist = TQStringList::split(',',printer->option("_kde-filters"),false);
    TQMap<TQString,TQString>    opts = printer->options();
 
    // generic page selection mechanism (using psselect filter)
    // do it only if:
    //  - using system-side page selection
    //  - special printer or regular printer without page selection support in current plugin
    //  - one of the page selection option has been selected to non default value
    // Action -> add the psselect filter to the filter chain.
    if (printer->pageSelection() == KPrinter::SystemSide &&
        (printer->option("kde-isspecial") == "1" || !(KMFactory::self()->uiManager()->pluginPageCap() & KMUiManager::PSSelect)) &&
        (printer->pageOrder() == KPrinter::LastPageFirst ||
         !printer->option("kde-range").isEmpty() ||
         printer->pageSet() != KPrinter::AllPages))
    {
        if (flist.findIndex("psselect") == -1)
        {
            int index = KXmlCommandManager::self()->insertCommand(flist, "psselect", false);
            if (index == -1 || !KXmlCommandManager::self()->checkCommand("psselect"))
            {
                printer->setErrorMessage(i18n("<p>Unable to perform the requested page selection. The filter <b>psselect</b> "
                                  "cannot be inserted in the current filter chain. See <b>Filter</b> tab in the "
                                  "printer properties dialog for further information.</p>"));
                return -1;
            }
        }
        if (printer->pageOrder() == KPrinter::LastPageFirst)
            opts["_kde-psselect-order"] = "r";
        if (!printer->option("kde-range").isEmpty())
            opts["_kde-psselect-range"] = printer->option("kde-range");
        if (printer->pageSet() != KPrinter::AllPages)
            opts["_kde-psselect-set"] = (printer->pageSet() == KPrinter::OddPages ? "-o" : "-e");
    }
 
    return doFilterFiles(printer, files, flist, opts, flag);
}
 
int KPrinterImpl::doFilterFiles(KPrinter *printer, TQStringList& files, const TQStringList& flist, const TQMap<TQString,TQString>& opts, bool flag)
{
    // nothing to do
    if (flist.count() == 0)
        return 0;
 
    TQString    filtercmd;
    TQStringList    inputMimeTypes;
    for (uint i=0;i<flist.count();i++)
    {
        KXmlCommand *filter = KXmlCommandManager::self()->loadCommand(flist[i]);
        if (!filter)
        {
            printer->setErrorMessage(i18n("<p>Could not load filter description for <b>%1</b>.</p>").arg(flist[i]));
            return -1; // Error
        }
        if (i == 0)
            inputMimeTypes = filter->inputMimeTypes();
 
        TQString        subcmd = filter->buildCommand(opts,(i>0),(i<(flist.count()-1)));
        delete filter;
        if (!subcmd.isEmpty())
        {
            filtercmd.append(subcmd);
            if (i < flist.count()-1)
                filtercmd.append("| ");
        }
        else
        {
            printer->setErrorMessage(i18n("<p>Error while reading filter description for <b>%1</b>. Empty command line received.</p>").arg(flist[i]));
            return -1;
        }
    }
    kdDebug(500) << "tdeprint: filter command: " << filtercmd << endl;
 
    TQString    rin("%in"), rout("%out"), rpsl("%psl"), rpsu("%psu");
    TQString    ps = pageSizeToPageName( printer->option( "kde-printsize" ).isEmpty() ? printer->pageSize() : ( KPrinter::PageSize )printer->option( "kde-printsize" ).toInt() );
    for (TQStringList::Iterator it=files.begin(); it!=files.end(); ++it)
    {
        TQString    mime = KMimeMagic::self()->findFileType(*it)->mimeType();
        if (inputMimeTypes.find(mime) == inputMimeTypes.end())
        {
            if (KMessageBox::warningContinueCancel(0,
                "<p>" + i18n("The MIME type %1 is not supported as input of the filter chain "
                     "(this may happen with non-CUPS spoolers when performing page selection "
                     "on a non-PostScript file). Do you want TDE to convert the file to a supported "
                     "format?</p>").arg(mime),
                TQString::null, i18n("Convert")) == KMessageBox::Continue)
            {
                TQStringList    ff;
                int done(0);
 
                ff << *it;
                while (done == 0)
                {
                    bool    ok(false);
                    TQString    targetMime = KInputDialog::getItem(
                        i18n("Select MIME Type"),
                        i18n("Select the target format for the conversion:"),
                        inputMimeTypes, 0, false, &ok);
                    if (!ok)
                    {
                        printer->setErrorMessage(i18n("Operation aborted."));
                        return -1;
                    }
                    TQStringList    filters = KXmlCommandManager::self()->autoConvert(mime, targetMime);
                    if (filters.count() == 0)
                    {
                        KMessageBox::error(0, i18n("No appropriate filter found. Select another target format."));
                    }
                    else
                    {
                        int result = doFilterFiles(printer, ff, filters, TQMap<TQString,TQString>(), flag);
                        if (result == 1)
                        {
                            *it = ff[0];
                            done = 1;
                        }
                        else
                        {
                            KMessageBox::error(0,
                                i18n("<qt>Operation failed with message:<br>%1<br>Select another target format.</qt>").arg(printer->errorMessage()));
                        }
                    }
                }
            }
            else
            {
                printer->setErrorMessage(i18n("Operation aborted."));
                return -1;
            }
        }
 
        TQString    tmpfile = tempFile();
        TQString    cmd(filtercmd);
        cmd.replace(rout,quote(tmpfile));
        cmd.replace(rpsl,ps.lower());
        cmd.replace(rpsu,ps);
        cmd.replace(rin,quote(*it)); // Replace as last, filename could contain "%psl"
        statusMessage(i18n("Filtering print data"), printer);
        int status = system(TQFile::encodeName(cmd));
        if (status < 0 || WEXITSTATUS(status) == 127)
        {
            printer->setErrorMessage(i18n("Error while filtering. Command was: <b>%1</b>.").arg(filtercmd));
            return -1;
        }
        if (flag) TQFile::remove(*it);
        *it = tmpfile;
    }
    return 1;
}
 
int KPrinterImpl::autoConvertFiles(KPrinter *printer, TQStringList& files, bool flag)
{
    TQString primaryMimeType = "application/postscript";
    TQStringList mimeTypes( primaryMimeType );
    if ( printer->option( "kde-isspecial" ) == "1" )
    {
        if ( !printer->option( "kde-special-command" ).isEmpty() )
        {
            KXmlCommand *cmd = KXmlCommandManager::self()->loadCommand( printer->option( "kde-special-command" ), true );
            if ( cmd )
            {
                mimeTypes = cmd->inputMimeTypes();
                // FIXME: the XML command description should now contain a primiary
                // mime type as well. This is a temporary-only solution.
                primaryMimeType = mimeTypes[ 0 ];
            }
        }
    }
    else
    {
        KMFactory::PluginInfo   info = KMFactory::self()->pluginInfo(KMFactory::self()->printSystem());
        mimeTypes = info.mimeTypes;
        primaryMimeType = info.primaryMimeType;
    }
    KMFactory::PluginInfo   info = KMFactory::self()->pluginInfo(KMFactory::self()->printSystem());
    int     status(0), result;
    for (TQStringList::Iterator it=files.begin(); it!=files.end(); )
    {
        TQString    mime = KMimeMagic::self()->findFileType(*it)->mimeType();
        if ( mime == "application/x-zerosize" )
        {
            // special case of empty file
            KMessageBox::information( NULL,
                    i18n( "<qt>The print file is empty and will be ignored:<p>%1</p></qt>" ).arg( *it ),
                    TQString::null, "emptyFileNotPrinted" );
            if ( flag )
                TQFile::remove( *it );
            it = files.remove( it );
            continue;
        }
        else if (mimeTypes.findIndex(mime) == -1)
        {
            if ((result=KMessageBox::warningYesNoCancel(NULL,
                           i18n("<qt>The file format <em> %1 </em> is not directly supported by the current print system. You "
                            "now have 3 options: "
                            "<ul> "
                            "<li> TDE can attempt to convert this file automatically to a supported format. "
                            "(Select <em>Convert</em>) </li>"
                            "<li> You can try to send the file to the printer without any conversion. "
                            "(Select <em>Keep</em>) </li>"
                            "<li> You can cancel the printjob. "
                            "(Select <em>Cancel</em>) </li>"
                            "</ul> "
                            "Do you want TDE to attempt and convert this file to %2?</qt>").arg(mime).arg(primaryMimeType),
                           TQString::null,
                           i18n("Convert"),
                           i18n("Keep"),
                           TQString::fromLatin1("tdeprintAutoConvert"))) == KMessageBox::Yes)
            {
                // find the filter chain
                TQStringList    flist = KXmlCommandManager::self()->autoConvert(mime, primaryMimeType);
                if (flist.count() == 0)
                {
                    KMessageBox::error(NULL,
                            i18n("<qt>No appropriate filter was found to convert the file format %1 into %2.<br>"
                                 "<ul>"
                                 "<li>Go to <i>System Options -> Commands</i> to look through the list of "
                                 "possible filters. Each filter executes an external program.</li>"
                                 "<li> See if the required external program is available.on your "
                                 "system.</li>"
                                 "</ul>"
                                 "</qt>").arg(mime).arg(primaryMimeType),
                                  i18n("Print"));
                    if (flag)
                        TQFile::remove(*it);
                    it = files.remove(it);
                    continue;
                }
                TQStringList    l(*it);
                switch (doFilterFiles(printer, l, flist, TQMap<TQString,TQString>(), flag))
                {
                    case -1:
                        return -1;
                    case 0:
                        break;
                    case 1:
                        status = 1;
                        *it = l[0];
                        break;
                }
            }
            else if (result == KMessageBox::Cancel)
            {
                files.clear();
                return 0;
            }
        }
        ++it;
    }
    return status;
}
 
bool KPrinterImpl::setupSpecialCommand(TQString& cmd, KPrinter *p, const TQStringList&)
{
    TQString    s(p->option("kde-special-command"));
    if (s.isEmpty())
    {
        p->setErrorMessage("Empty command.");
        return false;
    }
 
    s = KMFactory::self()->specialManager()->setupCommand(s, p->options());
 
    TQString    ps = pageSizeToPageName( p->option( "kde-printsize" ).isEmpty() ? p->pageSize() : ( KPrinter::PageSize )p->option( "kde-printsize" ).toInt() );
    s.replace("%psl", ps.lower());
    s.replace("%psu", ps);
    s.replace("%out", "$out{" + p->outputFileName() + "}"); // Replace as last
    cmd = s;
    return true;
}
 
TQString KPrinterImpl::quote(const TQString& s)
{ return TDEProcess::quote(s); }
 
void KPrinterImpl::saveOptions(const TQMap<TQString,TQString>& opts)
{
    m_options = opts;
    saveAppOptions();
}
 
void KPrinterImpl::loadAppOptions()
{
    TDEConfig   *conf = TDEGlobal::config();
    conf->setGroup("KPrinter Settings");
    TQStringList    opts = conf->readListEntry("ApplicationOptions");
    for (uint i=0; i<opts.count(); i+=2)
        if (opts[i].startsWith("app-"))
            m_options[opts[i]] = opts[i+1];
}
 
void KPrinterImpl::saveAppOptions()
{
    TQStringList    optlist;
    for (TQMap<TQString,TQString>::ConstIterator it=m_options.begin(); it!=m_options.end(); ++it)
        if (it.key().startsWith("app-"))
            optlist << it.key() << it.data();
 
    TDEConfig   *conf = TDEGlobal::config();
    conf->setGroup("KPrinter Settings");
    conf->writeEntry("ApplicationOptions", optlist);
}
 
#include "kprinterimpl.moc"