/* * Copyright 2000-2008 Sun Microsystems, Inc. All Rights Reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Sun designates this * particular file as subject to the "Classpath" exception as provided * by Sun in the LICENSE file that accompanied this code. * * This code 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 General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, * CA 95054 USA or visit www.sun.com if you need additional information or * have any questions. */ package sun.print; import java.net.URI; import java.net.URL; import java.io.BufferedInputStream; import java.io.BufferedOutputStream; import java.io.BufferedReader; import java.io.BufferedWriter; import java.io.File; import java.io.FileOutputStream; import java.io.InputStream; import java.io.InputStreamReader; import java.io.OutputStream; import java.io.OutputStreamWriter; import java.io.IOException; import java.io.Reader; import java.io.UnsupportedEncodingException; import java.util.Vector; import javax.print.CancelablePrintJob; import javax.print.Doc; import javax.print.DocFlavor; import javax.print.DocPrintJob; import javax.print.PrintService; import javax.print.PrintException; import javax.print.event.PrintJobEvent; import javax.print.event.PrintJobListener; import javax.print.event.PrintJobAttributeListener; import javax.print.attribute.Attribute; import javax.print.attribute.AttributeSet; import javax.print.attribute.AttributeSetUtilities; import javax.print.attribute.DocAttributeSet; import javax.print.attribute.HashPrintJobAttributeSet; import javax.print.attribute.HashPrintRequestAttributeSet; import javax.print.attribute.PrintJobAttribute; import javax.print.attribute.PrintJobAttributeSet; import javax.print.attribute.PrintRequestAttribute; import javax.print.attribute.PrintRequestAttributeSet; import javax.print.attribute.standard.Copies; import javax.print.attribute.standard.Destination; import javax.print.attribute.standard.DocumentName; import javax.print.attribute.standard.Fidelity; import javax.print.attribute.standard.JobName; import javax.print.attribute.standard.JobOriginatingUserName; import javax.print.attribute.standard.JobSheets; import javax.print.attribute.standard.Media; import javax.print.attribute.standard.MediaSize; import javax.print.attribute.standard.MediaSizeName; import javax.print.attribute.standard.OrientationRequested; import javax.print.attribute.standard.RequestingUserName; import javax.print.attribute.standard.NumberUp; import javax.print.attribute.standard.Sides; import javax.print.attribute.standard.PrinterIsAcceptingJobs; import java.awt.print.*; public class UnixPrintJob implements CancelablePrintJob { private static String debugPrefix = "UnixPrintJob>> "; transient private Vector jobListeners; transient private Vector attrListeners; transient private Vector listenedAttributeSets; private PrintService service; private boolean fidelity; private boolean printing = false; private boolean printReturned = false; private PrintRequestAttributeSet reqAttrSet = null; private PrintJobAttributeSet jobAttrSet = null; private PrinterJob job; private Doc doc; /* these variables used globally to store reference to the print * data retrieved as a stream. On completion these are always closed * if non-null. */ private InputStream instream = null; private Reader reader = null; /* default values overridden by those extracted from the attributes */ private String jobName = "Java Printing"; private int copies = 1; private MediaSizeName mediaName = MediaSizeName.NA_LETTER; private MediaSize mediaSize = MediaSize.NA.LETTER; private CustomMediaTray customTray = null; private OrientationRequested orient = OrientationRequested.PORTRAIT; private NumberUp nUp = null; private Sides sides = null; UnixPrintJob(PrintService service) { this.service = service; mDestination = service.getName(); mDestType = UnixPrintJob.DESTPRINTER; } public PrintService getPrintService() { return service; } public PrintJobAttributeSet getAttributes() { synchronized (this) { if (jobAttrSet == null) { /* just return an empty set until the job is submitted */ PrintJobAttributeSet jobSet = new HashPrintJobAttributeSet(); return AttributeSetUtilities.unmodifiableView(jobSet); } else { return jobAttrSet; } } } public void addPrintJobListener(PrintJobListener listener) { synchronized (this) { if (listener == null) { return; } if (jobListeners == null) { jobListeners = new Vector(); } jobListeners.add(listener); } } public void removePrintJobListener(PrintJobListener listener) { synchronized (this) { if (listener == null || jobListeners == null ) { return; } jobListeners.remove(listener); if (jobListeners.isEmpty()) { jobListeners = null; } } } /* Closes any stream already retrieved for the data. * We want to avoid unnecessarily asking the Doc to create a stream only * to get a reference in order to close it because the job failed. * If the representation class is itself a "stream", this * closes that stream too. */ private void closeDataStreams() { if (doc == null) { return; } Object data = null; try { data = doc.getPrintData(); } catch (IOException e) { return; } if (instream != null) { try { instream.close(); } catch (IOException e) { } finally { instream = null; } } else if (reader != null) { try { reader.close(); } catch (IOException e) { } finally { reader = null; } } else if (data instanceof InputStream) { try { ((InputStream)data).close(); } catch (IOException e) { } } else if (data instanceof Reader) { try { ((Reader)data).close(); } catch (IOException e) { } } } private void notifyEvent(int reason) { /* since this method should always get called, here's where * we will perform the clean up of any data stream supplied. */ switch (reason) { case PrintJobEvent.DATA_TRANSFER_COMPLETE: case PrintJobEvent.JOB_CANCELED : case PrintJobEvent.JOB_FAILED : case PrintJobEvent.NO_MORE_EVENTS : case PrintJobEvent.JOB_COMPLETE : closeDataStreams(); } synchronized (this) { if (jobListeners != null) { PrintJobListener listener; PrintJobEvent event = new PrintJobEvent(this, reason); for (int i = 0; i < jobListeners.size(); i++) { listener = (PrintJobListener)(jobListeners.elementAt(i)); switch (reason) { case PrintJobEvent.JOB_CANCELED : listener.printJobCanceled(event); break; case PrintJobEvent.JOB_FAILED : listener.printJobFailed(event); break; case PrintJobEvent.DATA_TRANSFER_COMPLETE : listener.printDataTransferCompleted(event); break; case PrintJobEvent.NO_MORE_EVENTS : listener.printJobNoMoreEvents(event); break; default: break; } } } } } public void addPrintJobAttributeListener( PrintJobAttributeListener listener, PrintJobAttributeSet attributes) { synchronized (this) { if (listener == null) { return; } if (attrListeners == null) { attrListeners = new Vector(); listenedAttributeSets = new Vector(); } attrListeners.add(listener); if (attributes == null) { attributes = new HashPrintJobAttributeSet(); } listenedAttributeSets.add(attributes); } } public void removePrintJobAttributeListener( PrintJobAttributeListener listener) { synchronized (this) { if (listener == null || attrListeners == null ) { return; } int index = attrListeners.indexOf(listener); if (index == -1) { return; } else { attrListeners.remove(index); listenedAttributeSets.remove(index); if (attrListeners.isEmpty()) { attrListeners = null; listenedAttributeSets = null; } } } } public void print(Doc doc, PrintRequestAttributeSet attributes) throws PrintException { synchronized (this) { if (printing) { throw new PrintException("already printing"); } else { printing = true; } } if ((PrinterIsAcceptingJobs)(service.getAttribute( PrinterIsAcceptingJobs.class)) == PrinterIsAcceptingJobs.NOT_ACCEPTING_JOBS) { throw new PrintException("Printer is not accepting job."); } this.doc = doc; /* check if the parameters are valid before doing much processing */ DocFlavor flavor = doc.getDocFlavor(); Object data; try { data = doc.getPrintData(); } catch (IOException e) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException("can't get print data: " + e.toString()); } if (flavor == null || (!service.isDocFlavorSupported(flavor))) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintJobFlavorException("invalid flavor", flavor); } initializeAttributeSets(doc, attributes); getAttributeValues(flavor); // set up mOptions if ((service instanceof IPPPrintService) && CUPSPrinter.isCupsRunning()) { IPPPrintService.debug_println(debugPrefix+ "instanceof IPPPrintService"); if (mediaName != null) { CustomMediaSizeName customMedia = ((IPPPrintService)service).findCustomMedia(mediaName); if (customMedia != null) { mOptions = " media="+ customMedia.getChoiceName(); } } if (customTray != null && customTray instanceof CustomMediaTray) { String choice = customTray.getChoiceName(); if (choice != null) { mOptions += " media="+choice; } } if (nUp != null) { mOptions += " number-up="+nUp.getValue(); } if (orient != OrientationRequested.PORTRAIT && (flavor != null) && !flavor.equals(DocFlavor.SERVICE_FORMATTED.PAGEABLE)) { mOptions += " orientation-requested="+orient.getValue(); } if (sides != null) { mOptions += " sides="+sides; } } IPPPrintService.debug_println(debugPrefix+"mOptions "+mOptions); String repClassName = flavor.getRepresentationClassName(); String val = flavor.getParameter("charset"); String encoding = "us-ascii"; if (val != null && !val.equals("")) { encoding = val; } if (flavor.equals(DocFlavor.INPUT_STREAM.GIF) || flavor.equals(DocFlavor.INPUT_STREAM.JPEG) || flavor.equals(DocFlavor.INPUT_STREAM.PNG) || flavor.equals(DocFlavor.BYTE_ARRAY.GIF) || flavor.equals(DocFlavor.BYTE_ARRAY.JPEG) || flavor.equals(DocFlavor.BYTE_ARRAY.PNG)) { try { instream = doc.getStreamForBytes(); if (instream == null) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException("No stream for data"); } if (!(service instanceof IPPPrintService && ((IPPPrintService)service).isIPPSupportedImages( flavor.getMimeType()))) { printableJob(new ImagePrinter(instream)); ((UnixPrintService)service).wakeNotifier(); return; } } catch (ClassCastException cce) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(cce); } catch (IOException ioe) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(ioe); } } else if (flavor.equals(DocFlavor.URL.GIF) || flavor.equals(DocFlavor.URL.JPEG) || flavor.equals(DocFlavor.URL.PNG)) { try { URL url = (URL)data; if ((service instanceof IPPPrintService) && ((IPPPrintService)service).isIPPSupportedImages( flavor.getMimeType())) { instream = url.openStream(); } else { printableJob(new ImagePrinter(url)); ((UnixPrintService)service).wakeNotifier(); return; } } catch (ClassCastException cce) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(cce); } catch (IOException e) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(e.toString()); } } else if (flavor.equals(DocFlavor.CHAR_ARRAY.TEXT_PLAIN) || flavor.equals(DocFlavor.READER.TEXT_PLAIN) || flavor.equals(DocFlavor.STRING.TEXT_PLAIN)) { try { reader = doc.getReaderForText(); if (reader == null) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException("No reader for data"); } } catch (IOException ioe) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(ioe.toString()); } } else if (repClassName.equals("[B") || repClassName.equals("java.io.InputStream")) { try { instream = doc.getStreamForBytes(); if (instream == null) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException("No stream for data"); } } catch (IOException ioe) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(ioe.toString()); } } else if (repClassName.equals("java.net.URL")) { /* * This extracts the data from the URL and passes it the content * directly to the print service as a file. * This is appropriate for the current implementation where lp or * lpr is always used to spool the data. We expect to revise the * implementation to provide more complete IPP support (ie not just * CUPS) and at that time the job will be spooled via IPP * and the URL * itself should be sent to the IPP print service not the content. */ URL url = (URL)data; try { instream = url.openStream(); } catch (IOException e) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(e.toString()); } } else if (repClassName.equals("java.awt.print.Pageable")) { try { pageableJob((Pageable)doc.getPrintData()); if (service instanceof IPPPrintService) { ((IPPPrintService)service).wakeNotifier(); } else { ((UnixPrintService)service).wakeNotifier(); } return; } catch (ClassCastException cce) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(cce); } catch (IOException ioe) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(ioe); } } else if (repClassName.equals("java.awt.print.Printable")) { try { printableJob((Printable)doc.getPrintData()); if (service instanceof IPPPrintService) { ((IPPPrintService)service).wakeNotifier(); } else { ((UnixPrintService)service).wakeNotifier(); } return; } catch (ClassCastException cce) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(cce); } catch (IOException ioe) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(ioe); } } else { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException("unrecognized class: "+repClassName); } // now spool the print data. PrinterOpener po = new PrinterOpener(); java.security.AccessController.doPrivileged(po); if (po.pex != null) { throw po.pex; } OutputStream output = po.result; /* There are three cases: * 1) Text data from a Reader, just pass through. * 2) Text data from an input stream which we must read using the * correct encoding * 3) Raw byte data from an InputStream we don't interpret as text, * just pass through: eg postscript. */ BufferedWriter bw = null; if ((instream == null && reader != null)) { BufferedReader br = new BufferedReader(reader); OutputStreamWriter osw = new OutputStreamWriter(output); bw = new BufferedWriter(osw); char []buffer = new char[1024]; int cread; try { while ((cread = br.read(buffer, 0, buffer.length)) >=0) { bw.write(buffer, 0, cread); } br.close(); bw.flush(); bw.close(); } catch (IOException e) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException (e); } } else if (instream != null && flavor.getMediaType().equalsIgnoreCase("text")) { try { InputStreamReader isr = new InputStreamReader(instream, encoding); BufferedReader br = new BufferedReader(isr); OutputStreamWriter osw = new OutputStreamWriter(output); bw = new BufferedWriter(osw); char []buffer = new char[1024]; int cread; while ((cread = br.read(buffer, 0, buffer.length)) >=0) { bw.write(buffer, 0, cread); } bw.flush(); } catch (IOException e) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException (e); } finally { try { if (bw != null) { bw.close(); } } catch (IOException e) { } } } else if (instream != null) { BufferedInputStream bin = new BufferedInputStream(instream); BufferedOutputStream bout = new BufferedOutputStream(output); byte[] buffer = new byte[1024]; int bread = 0; try { while ((bread = bin.read(buffer)) >= 0) { bout.write(buffer, 0, bread); } bin.close(); bout.flush(); bout.close(); } catch (IOException e) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException (e); } } notifyEvent(PrintJobEvent.DATA_TRANSFER_COMPLETE); if (mDestType == UnixPrintJob.DESTPRINTER) { PrinterSpooler spooler = new PrinterSpooler(); java.security.AccessController.doPrivileged(spooler); if (spooler.pex != null) { throw spooler.pex; } } notifyEvent(PrintJobEvent.NO_MORE_EVENTS); if (service instanceof IPPPrintService) { ((IPPPrintService)service).wakeNotifier(); } else { ((UnixPrintService)service).wakeNotifier(); } } public void printableJob(Printable printable) throws PrintException { try { synchronized(this) { if (job != null) { // shouldn't happen throw new PrintException("already printing"); } else { job = new PSPrinterJob(); } } job.setPrintService(getPrintService()); job.setCopies(copies); job.setJobName(jobName); PageFormat pf = new PageFormat(); if (mediaSize != null) { Paper p = new Paper(); p.setSize(mediaSize.getX(MediaSize.INCH)*72.0, mediaSize.getY(MediaSize.INCH)*72.0); p.setImageableArea(72.0, 72.0, p.getWidth()-144.0, p.getHeight()-144.0); pf.setPaper(p); } if (orient == OrientationRequested.REVERSE_LANDSCAPE) { pf.setOrientation(PageFormat.REVERSE_LANDSCAPE); } else if (orient == OrientationRequested.LANDSCAPE) { pf.setOrientation(PageFormat.LANDSCAPE); } job.setPrintable(printable, pf); job.print(reqAttrSet); notifyEvent(PrintJobEvent.DATA_TRANSFER_COMPLETE); return; } catch (PrinterException pe) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(pe); } finally { printReturned = true; notifyEvent(PrintJobEvent.NO_MORE_EVENTS); } } public void pageableJob(Pageable pageable) throws PrintException { try { synchronized(this) { if (job != null) { // shouldn't happen throw new PrintException("already printing"); } else { job = new PSPrinterJob(); } } job.setPrintService(getPrintService()); job.setCopies(copies); job.setJobName(jobName); job.setPageable(pageable); job.print(reqAttrSet); notifyEvent(PrintJobEvent.DATA_TRANSFER_COMPLETE); return; } catch (PrinterException pe) { notifyEvent(PrintJobEvent.JOB_FAILED); throw new PrintException(pe); } finally { printReturned = true; notifyEvent(PrintJobEvent.NO_MORE_EVENTS); } } /* There's some inefficiency here as the job set is created even though * it may never be requested. */ private synchronized void initializeAttributeSets(Doc doc, PrintRequestAttributeSet reqSet) { reqAttrSet = new HashPrintRequestAttributeSet(); jobAttrSet = new HashPrintJobAttributeSet(); Attribute[] attrs; if (reqSet != null) { reqAttrSet.addAll(reqSet); attrs = reqSet.toArray(); for (int i=0; i 1) { pFlags |= COPIES; ncomps+=1; } if (noJobSheet) { pFlags |= NOSHEET; ncomps+=1; } if (UnixPrintServiceLookup.osname.equals("SunOS")) { ncomps+=1; // lp uses 1 more arg than lpr (make a copy) execCmd = new String[ncomps]; execCmd[n++] = "/usr/bin/lp"; execCmd[n++] = "-c"; // make a copy of the spool file if ((pFlags & PRINTER) != 0) { execCmd[n++] = "-d" + printer; } if ((pFlags & BANNER) != 0) { String quoteChar = "\""; execCmd[n++] = "-t " + quoteChar+banner+quoteChar; } if ((pFlags & COPIES) != 0) { execCmd[n++] = "-n " + copies; } if ((pFlags & NOSHEET) != 0) { execCmd[n++] = "-o nobanner"; } if ((pFlags & OPTIONS) != 0) { execCmd[n++] = "-o " + options; } } else { execCmd = new String[ncomps]; execCmd[n++] = "/usr/bin/lpr"; if ((pFlags & PRINTER) != 0) { execCmd[n++] = "-P" + printer; } if ((pFlags & BANNER) != 0) { execCmd[n++] = "-J " + banner; } if ((pFlags & COPIES) != 0) { execCmd[n++] = "-#" + copies; } if ((pFlags & NOSHEET) != 0) { execCmd[n++] = "-h"; } if ((pFlags & OPTIONS) != 0) { execCmd[n++] = "-o" + options; } } execCmd[n++] = spoolFile; if (IPPPrintService.debugPrint) { System.out.println("UnixPrintJob>> execCmd"); for (int i=0; i