/*

 * 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 javax.print.attribute.*;

import javax.print.attribute.standard.*;

import javax.print.DocFlavor;

import javax.print.DocPrintJob;

import javax.print.PrintService;

import javax.print.ServiceUIFactory;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Locale;

import java.util.Date;

import java.util.Arrays;

import java.security.AccessController;

import java.security.PrivilegedActionException;

import java.security.PrivilegedExceptionAction;

import javax.print.event.PrintServiceAttributeListener;

import java.net.URI;

import java.net.URISyntaxException;

import java.net.URL;

import java.net.HttpURLConnection;

import java.io.File;

import java.io.InputStream;

import java.io.OutputStream;

import java.io.OutputStreamWriter;

import java.io.DataInputStream;

import java.io.ByteArrayOutputStream;

import java.io.ByteArrayInputStream;

import java.io.BufferedReader;

import java.io.InputStreamReader;

import java.nio.charset.Charset;

import java.util.Iterator;

import java.util.HashSet;

public class IPPPrintService implements PrintService, SunPrinterJobService {

    public static boolean debugPrint = false;

    private static String debugPrefix = "IPPPrintService>> ";

    protected static void debug_println(String str) {

        if (debugPrint) {

            System.out.println(str);

        }

    }

    private String printer;

    private URI    myURI;

    private URL    myURL;

    transient private ServiceNotifier notifier = null;

    private static int MAXCOPIES = 1000;

    private static short MAX_ATTRIBUTE_LENGTH = 255;

    private CUPSPrinter cps;

    private HttpURLConnection urlConnection = null;

    private DocFlavor[] supportedDocFlavors;

    private Class[] supportedCats;

    private MediaTray[] mediaTrays;

    private MediaSizeName[] mediaSizeNames;

    private CustomMediaSizeName[] customMediaSizeNames;

    private int defaultMediaIndex;

    private boolean isCupsPrinter;

    private boolean init;

    private Boolean isPS;

    private HashMap getAttMap;

    private boolean pngImagesAdded = false;

    private boolean gifImagesAdded = false;

    private boolean jpgImagesAdded = false;

    /**

     * IPP Status Codes

     */

    private static final byte STATUSCODE_SUCCESS = 0x00;

    /**

     * IPP Group Tags.  Each tag is used once before the first attribute

     * of that group.

     */

    // operation attributes group

    private static final byte GRPTAG_OP_ATTRIBUTES = 0x01;

    // job attributes group

    private static final byte GRPTAG_JOB_ATTRIBUTES = 0x02;

    // printer attributes group

    private static final byte GRPTAG_PRINTER_ATTRIBUTES = 0x04;

    // used as the last tag in an IPP message.

    private static final byte GRPTAG_END_ATTRIBUTES = 0x03;

    /**

     * IPP Operation codes

     */

    // gets the attributes for a printer

    public static final String OP_GET_ATTRIBUTES = "000B";

    // gets the default printer

    public static final String OP_CUPS_GET_DEFAULT = "4001";

    // gets the list of printers

    public static final String OP_CUPS_GET_PRINTERS = "4002";

    /**

     * List of all PrintRequestAttributes.  This is used

     * for looping through all the IPP attribute name.

     */

    private static Object[] printReqAttribDefault = {

        Chromaticity.COLOR,

        new Copies(1),

        Fidelity.FIDELITY_FALSE,

        Finishings.NONE,

        //new JobHoldUntil(new Date()),

        //new JobImpressions(0),

        //JobImpressions,

        //JobKOctets,

        //JobMediaSheets,

        new JobName("", Locale.getDefault()),

        //JobPriority,

        JobSheets.NONE,

        (Media)MediaSizeName.NA_LETTER,

        //MediaPrintableArea.class, // not an IPP attribute

        //MultipleDocumentHandling.SINGLE_DOCUMENT,

        new NumberUp(1),

        OrientationRequested.PORTRAIT,

        new PageRanges(1),

        //PresentationDirection,

                 // CUPS does not supply printer-resolution attribute

        //new PrinterResolution(300, 300, PrinterResolution.DPI),

        //PrintQuality.NORMAL,

        new RequestingUserName("", Locale.getDefault()),

        //SheetCollate.UNCOLLATED, //CUPS has no sheet collate?

        Sides.ONE_SIDED,

    };

    /**

     * List of all PrintServiceAttributes.  This is used

     * for looping through all the IPP attribute name.

     */

    private static Object[][] serviceAttributes = {

        {ColorSupported.class, "color-supported"},

        {PagesPerMinute.class,  "pages-per-minute"},

        {PagesPerMinuteColor.class, "pages-per-minute-color"},

        {PDLOverrideSupported.class, "pdl-override-supported"},

        {PrinterInfo.class, "printer-info"},

        {PrinterIsAcceptingJobs.class, "printer-is-accepting-jobs"},

        {PrinterLocation.class, "printer-location"},

        {PrinterMakeAndModel.class, "printer-make-and-model"},

        {PrinterMessageFromOperator.class, "printer-message-from-operator"},

        {PrinterMoreInfo.class, "printer-more-info"},

        {PrinterMoreInfoManufacturer.class, "printer-more-info-manufacturer"},

        {PrinterName.class, "printer-name"},

        {PrinterState.class, "printer-state"},

        {PrinterStateReasons.class, "printer-state-reasons"},

        {PrinterURI.class, "printer-uri"},

        {QueuedJobCount.class, "queued-job-count"}

    };

    /**

     * List of DocFlavors, grouped based on matching mime-type.

     * NOTE: For any change in the predefined DocFlavors, it must be reflected

     * here also.

     */

    // PDF DocFlavors

    private static DocFlavor[] appPDF = {

        DocFlavor.BYTE_ARRAY.PDF,

        DocFlavor.INPUT_STREAM.PDF,

        DocFlavor.URL.PDF

    };

    // Postscript DocFlavors

    private static DocFlavor[] appPostScript = {

        DocFlavor.BYTE_ARRAY.POSTSCRIPT,

        DocFlavor.INPUT_STREAM.POSTSCRIPT,

        DocFlavor.URL.POSTSCRIPT

    };

    // Autosense DocFlavors

    private static DocFlavor[] appOctetStream = {

        DocFlavor.BYTE_ARRAY.AUTOSENSE,

        DocFlavor.INPUT_STREAM.AUTOSENSE,

        DocFlavor.URL.AUTOSENSE

    };

    // Text DocFlavors

    private static DocFlavor[] textPlain = {

        DocFlavor.BYTE_ARRAY.TEXT_PLAIN_UTF_8,

        DocFlavor.BYTE_ARRAY.TEXT_PLAIN_UTF_16,

        DocFlavor.BYTE_ARRAY.TEXT_PLAIN_UTF_16BE,

        DocFlavor.BYTE_ARRAY.TEXT_PLAIN_UTF_16LE,

        DocFlavor.BYTE_ARRAY.TEXT_PLAIN_US_ASCII,

        DocFlavor.INPUT_STREAM.TEXT_PLAIN_UTF_8,

        DocFlavor.INPUT_STREAM.TEXT_PLAIN_UTF_16,

        DocFlavor.INPUT_STREAM.TEXT_PLAIN_UTF_16BE,

        DocFlavor.INPUT_STREAM.TEXT_PLAIN_UTF_16LE,

        DocFlavor.INPUT_STREAM.TEXT_PLAIN_US_ASCII,

        DocFlavor.URL.TEXT_PLAIN_UTF_8,

        DocFlavor.URL.TEXT_PLAIN_UTF_16,

        DocFlavor.URL.TEXT_PLAIN_UTF_16BE,

        DocFlavor.URL.TEXT_PLAIN_UTF_16LE,

        DocFlavor.URL.TEXT_PLAIN_US_ASCII,

        DocFlavor.CHAR_ARRAY.TEXT_PLAIN,

        DocFlavor.STRING.TEXT_PLAIN,

        DocFlavor.READER.TEXT_PLAIN

    };

    private static DocFlavor[] textPlainHost = {

        DocFlavor.BYTE_ARRAY.TEXT_PLAIN_HOST,

        DocFlavor.INPUT_STREAM.TEXT_PLAIN_HOST,

        DocFlavor.URL.TEXT_PLAIN_HOST

    };

    // JPG DocFlavors

    private static DocFlavor[] imageJPG = {

        DocFlavor.BYTE_ARRAY.JPEG,

        DocFlavor.INPUT_STREAM.JPEG,

        DocFlavor.URL.JPEG

    };

    // GIF DocFlavors

    private static DocFlavor[] imageGIF = {

        DocFlavor.BYTE_ARRAY.GIF,

        DocFlavor.INPUT_STREAM.GIF,

        DocFlavor.URL.GIF

    };

    // PNG DocFlavors

    private static DocFlavor[] imagePNG = {

        DocFlavor.BYTE_ARRAY.PNG,

        DocFlavor.INPUT_STREAM.PNG,

        DocFlavor.URL.PNG

    };

    // HTML DocFlavors

    private  static DocFlavor[] textHtml = {

        DocFlavor.BYTE_ARRAY.TEXT_HTML_UTF_8,

        DocFlavor.BYTE_ARRAY.TEXT_HTML_UTF_16,

        DocFlavor.BYTE_ARRAY.TEXT_HTML_UTF_16BE,

        DocFlavor.BYTE_ARRAY.TEXT_HTML_UTF_16LE,

        DocFlavor.BYTE_ARRAY.TEXT_HTML_US_ASCII,

        DocFlavor.INPUT_STREAM.TEXT_HTML_UTF_8,

        DocFlavor.INPUT_STREAM.TEXT_HTML_UTF_16,

        DocFlavor.INPUT_STREAM.TEXT_HTML_UTF_16BE,

        DocFlavor.INPUT_STREAM.TEXT_HTML_UTF_16LE,

        DocFlavor.INPUT_STREAM.TEXT_HTML_US_ASCII,

        DocFlavor.URL.TEXT_HTML_UTF_8,

        DocFlavor.URL.TEXT_HTML_UTF_16,

        DocFlavor.URL.TEXT_HTML_UTF_16BE,

        DocFlavor.URL.TEXT_HTML_UTF_16LE,

        DocFlavor.URL.TEXT_HTML_US_ASCII,

        // These are not handled in UnixPrintJob so commenting these

        // for now.

        /*

        DocFlavor.CHAR_ARRAY.TEXT_HTML,

        DocFlavor.STRING.TEXT_HTML,

        DocFlavor.READER.TEXT_HTML,

        */

    };

    private  static DocFlavor[] textHtmlHost = {

        DocFlavor.BYTE_ARRAY.TEXT_HTML_HOST,

        DocFlavor.INPUT_STREAM.TEXT_HTML_HOST,

        DocFlavor.URL.TEXT_HTML_HOST,

    };

    // PCL DocFlavors

    private static DocFlavor[] appPCL = {

        DocFlavor.BYTE_ARRAY.PCL,

        DocFlavor.INPUT_STREAM.PCL,

        DocFlavor.URL.PCL

    };

    // List of all DocFlavors, used in looping

    // through all supported mime-types

    private static Object[] allDocFlavors = {

        appPDF, appPostScript, appOctetStream,

        textPlain, imageJPG, imageGIF, imagePNG,

        textHtml, appPCL,

    };

    IPPPrintService(String name, URL url) {

        if ((name == null) || (url == null)){

            throw new IllegalArgumentException("null uri or printer name");

        }

        printer = name;

        supportedDocFlavors = null;

        supportedCats = null;

        mediaSizeNames = null;

        customMediaSizeNames = null;

        mediaTrays = null;

        myURL = url;

        cps = null;

        isCupsPrinter = false;

        init = false;

        defaultMediaIndex = -1;

        String host = myURL.getHost();

        if (host!=null && host.equals(CUPSPrinter.getServer())) {

            isCupsPrinter = true;

            try {

                myURI =  new URI("ipp://"+host+

                                 "/printers/"+printer);

                debug_println(debugPrefix+"IPPPrintService myURI : "+myURI);

            } catch (java.net.URISyntaxException e) {

                throw new IllegalArgumentException("invalid url");

            }

        }

    }

    IPPPrintService(String name, String uriStr, boolean isCups) {

        if ((name == null) || (uriStr == null)){

            throw new IllegalArgumentException("null uri or printer name");

        }

        printer = name;

        supportedDocFlavors = null;

        supportedCats = null;

        mediaSizeNames = null;

        customMediaSizeNames = null;

        mediaTrays = null;

        cps = null;

        init = false;

        defaultMediaIndex = -1;

        try {

            myURL =

                new URL(uriStr.replaceFirst("ipp", "http"));

        } catch (Exception e) {

            IPPPrintService.debug_println(debugPrefix+

                                          " IPPPrintService, myURL="+

                                          myURL+" Exception= "+

                                          e);

        }

        isCupsPrinter = isCups;

        try {

            myURI =  new URI(uriStr);

            debug_println(debugPrefix+"IPPPrintService myURI : "+myURI);

        } catch (java.net.URISyntaxException e) {

            throw new IllegalArgumentException("invalid uri");

        }

    }

    /*

     * Initialize mediaSizeNames, mediaTrays and other attributes.

     * Media size/trays are initialized to non-null values, may be 0-length

     * array.

     * NOTE: Must be called from a synchronized block only.

     */

    private void initAttributes() {

        if (!init) {

            // init customMediaSizeNames

            customMediaSizeNames = new CustomMediaSizeName[0];

            if ((urlConnection = getIPPConnection(myURL)) == null) {

                mediaSizeNames = new MediaSizeName[0];

                mediaTrays = new MediaTray[0];

                debug_println("NULL urlConnection ");

                init = true;

                return;

            }

            // get all supported attributes through IPP

            opGetAttributes();

            if (isCupsPrinter) {

                // note, it is possible to query media in CUPS using IPP

                // right now we always get it from PPD.

                // maybe use "&& (usePPD)" later?

                // Another reason why we use PPD is because

                // IPP currently does not support it but PPD does.

                try {

                    cps = new CUPSPrinter(printer);

                    mediaSizeNames = cps.getMediaSizeNames();

                    mediaTrays = cps.getMediaTrays();

                    customMediaSizeNames = cps.getCustomMediaSizeNames();

                    urlConnection.disconnect();

                    init = true;

                    return;

                } catch (Exception e) {

                    IPPPrintService.debug_println(debugPrefix+

                                       " error creating CUPSPrinter e="+e);

                }

            }

            // use IPP to get all media,

            Media[] allMedia = (Media[])getSupportedMedia();

            ArrayList sizeList = new ArrayList();

            ArrayList trayList = new ArrayList();

            for (int i=0; i<allMedia.length; i++) {

                if (allMedia[i] instanceof MediaSizeName) {

                    sizeList.add(allMedia[i]);

                } else if (allMedia[i] instanceof MediaTray) {

                    trayList.add(allMedia[i]);

                }

            }

            if (sizeList != null) {

                mediaSizeNames = new MediaSizeName[sizeList.size()];

                mediaSizeNames = (MediaSizeName[])sizeList.toArray(

                                                       mediaSizeNames);

            }

            if (trayList != null) {

                mediaTrays = new MediaTray[trayList.size()];

                mediaTrays = (MediaTray[])trayList.toArray(

                                                           mediaTrays);

            }

            urlConnection.disconnect();

            init = true;

        }

    }

    public DocPrintJob createPrintJob() {

        SecurityManager security = System.getSecurityManager();

        if (security != null) {

            security.checkPrintJobAccess();

        }

        // REMIND: create IPPPrintJob

        return new UnixPrintJob(this);

    }

    public synchronized Object

        getSupportedAttributeValues(Class<? extends Attribute> category,

                                    DocFlavor flavor,

                                    AttributeSet attributes)

    {

        if (category == null) {

            throw new NullPointerException("null category");

        }

        if (!Attribute.class.isAssignableFrom(category)) {

            throw new IllegalArgumentException(category +

                                 " does not implement Attribute");

        }

        if (flavor != null) {

            if (!isDocFlavorSupported(flavor)) {

                throw new IllegalArgumentException(flavor +

                                               " is an unsupported flavor");

            } else if (isAutoSense(flavor)) {

                return null;

            }

        }

        if (!isAttributeCategorySupported(category)) {

            return null;

        }

        /* Test if the flavor is compatible with the attributes */

        if (!isDestinationSupported(flavor, attributes)) {

            return null;

        }

        initAttributes();

        /* Test if the flavor is compatible with the category */

        if ((category == Copies.class) ||

            (category == CopiesSupported.class)) {

            CopiesSupported cs = new CopiesSupported(1, MAXCOPIES);

            AttributeClass attribClass = (getAttMap != null) ?

                (AttributeClass)getAttMap.get(cs.getName()) : null;

            if (attribClass != null) {

                int[] range = attribClass.getIntRangeValue();

                cs = new CopiesSupported(range[0], range[1]);

            }

            return cs;

        } else  if (category == Chromaticity.class) {

            if (flavor == null ||

                flavor.equals(DocFlavor.SERVICE_FORMATTED.PAGEABLE) ||

                flavor.equals(DocFlavor.SERVICE_FORMATTED.PRINTABLE) ||

                flavor.equals(DocFlavor.BYTE_ARRAY.GIF) ||

                flavor.equals(DocFlavor.INPUT_STREAM.GIF) ||

                flavor.equals(DocFlavor.URL.GIF) ||

                flavor.equals(DocFlavor.BYTE_ARRAY.JPEG) ||

                flavor.equals(DocFlavor.INPUT_STREAM.JPEG) ||

                flavor.equals(DocFlavor.URL.JPEG) ||

                flavor.equals(DocFlavor.BYTE_ARRAY.PNG) ||

                flavor.equals(DocFlavor.INPUT_STREAM.PNG) ||

                flavor.equals(DocFlavor.URL.PNG)) {

                Chromaticity[]arr = new Chromaticity[1];

                arr[0] = Chromaticity.COLOR;

                return (arr);

            } else {

                return null;

            }

        } else if (category == Destination.class) {

            if (flavor == null ||

                flavor.equals(DocFlavor.SERVICE_FORMATTED.PAGEABLE) ||

                flavor.equals(DocFlavor.SERVICE_FORMATTED.PRINTABLE)) {

                try {

                    return new Destination((new File("out.ps")).toURI());

                } catch (SecurityException se) {

                    try {

                        return new Destination(new URI("file:out.ps"));