/*

 * Copyright (c) 2000, 2007, Oracle and/or its affiliates. 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.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package sun.print;

import java.io.File;

import java.net.URI;

import java.net.URISyntaxException;

import java.util.ArrayList;

import java.util.Locale;

import javax.print.DocFlavor;

import javax.print.DocPrintJob;

import javax.print.PrintService;

import javax.print.ServiceUIFactory;

import javax.print.attribute.Attribute;

import javax.print.attribute.AttributeSet;

import javax.print.attribute.AttributeSetUtilities;

import javax.print.attribute.HashAttributeSet;

import javax.print.attribute.PrintServiceAttribute;

import javax.print.attribute.PrintServiceAttributeSet;

import javax.print.attribute.HashPrintServiceAttributeSet;

import javax.print.attribute.Size2DSyntax;

import javax.print.attribute.standard.PrinterName;

import javax.print.attribute.standard.PrinterIsAcceptingJobs;

import javax.print.attribute.standard.QueuedJobCount;

import javax.print.attribute.standard.JobName;

import javax.print.attribute.standard.JobSheets;

import javax.print.attribute.standard.RequestingUserName;

import javax.print.attribute.standard.Chromaticity;

import javax.print.attribute.standard.ColorSupported;

import javax.print.attribute.standard.Copies;

import javax.print.attribute.standard.CopiesSupported;

import javax.print.attribute.standard.Destination;

import javax.print.attribute.standard.Fidelity;

import javax.print.attribute.standard.Media;

import javax.print.attribute.standard.MediaPrintableArea;

import javax.print.attribute.standard.MediaSize;

import javax.print.attribute.standard.MediaSizeName;

import javax.print.attribute.standard.OrientationRequested;

import javax.print.attribute.standard.PageRanges;

import javax.print.attribute.standard.PrinterState;

import javax.print.attribute.standard.PrinterStateReason;

import javax.print.attribute.standard.PrinterStateReasons;

import javax.print.attribute.standard.Severity;

import javax.print.attribute.standard.SheetCollate;

import javax.print.attribute.standard.Sides;

import javax.print.event.PrintServiceAttributeListener;

public class UnixPrintService implements PrintService, AttributeUpdater,

                                         SunPrinterJobService {

    /* define doc flavors for text types in the default encoding of

     * this platform since we can always read those.

     */

    private static String encoding = "ISO8859_1";

    private static DocFlavor textByteFlavor;

    private static DocFlavor[] supportedDocFlavors = null;

    private static final DocFlavor[] supportedDocFlavorsInit = {

         DocFlavor.BYTE_ARRAY.POSTSCRIPT,

         DocFlavor.INPUT_STREAM.POSTSCRIPT,

         DocFlavor.URL.POSTSCRIPT,

         DocFlavor.BYTE_ARRAY.GIF,

         DocFlavor.INPUT_STREAM.GIF,

         DocFlavor.URL.GIF,

         DocFlavor.BYTE_ARRAY.JPEG,

         DocFlavor.INPUT_STREAM.JPEG,

         DocFlavor.URL.JPEG,

         DocFlavor.BYTE_ARRAY.PNG,

         DocFlavor.INPUT_STREAM.PNG,

         DocFlavor.URL.PNG,

         DocFlavor.CHAR_ARRAY.TEXT_PLAIN,

         DocFlavor.READER.TEXT_PLAIN,

         DocFlavor.STRING.TEXT_PLAIN,

         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.SERVICE_FORMATTED.PAGEABLE,

         DocFlavor.SERVICE_FORMATTED.PRINTABLE,

         DocFlavor.BYTE_ARRAY.AUTOSENSE,

         DocFlavor.URL.AUTOSENSE,

         DocFlavor.INPUT_STREAM.AUTOSENSE

    };

    private static final DocFlavor[] supportedHostDocFlavors = {

        DocFlavor.BYTE_ARRAY.TEXT_PLAIN_HOST,

        DocFlavor.INPUT_STREAM.TEXT_PLAIN_HOST,

        DocFlavor.URL.TEXT_PLAIN_HOST

    };

    String[] lpcStatusCom = {

      "",

      "| grep -E '^[ 0-9a-zA-Z_-]*@' | awk '{print $2, $3}'"

    };

    String[] lpcQueueCom = {

      "",

      "| grep -E '^[ 0-9a-zA-Z_-]*@' | awk '{print $4}'"

    };

    static {

        encoding = java.security.AccessController.doPrivileged(

            new sun.security.action.GetPropertyAction("file.encoding"));

    }

    /* let's try to support a few of these */

    private static final Class<?>[] serviceAttrCats = {

        PrinterName.class,

        PrinterIsAcceptingJobs.class,

        QueuedJobCount.class,

    };

    /*  it turns out to be inconvenient to store the other categories

     *  separately because many attributes are in multiple categories.

     */

    private static final Class<?>[] otherAttrCats = {

        Chromaticity.class,

        Copies.class,

        Destination.class,

        Fidelity.class,

        JobName.class,

        JobSheets.class,

        Media.class, /* have to support this somehow ... */

        MediaPrintableArea.class,

        OrientationRequested.class,

        PageRanges.class,

        RequestingUserName.class,

        SheetCollate.class,

        Sides.class,

    };

    private static int MAXCOPIES = 1000;

    private static final MediaSizeName mediaSizes[] = {

        MediaSizeName.NA_LETTER,

        MediaSizeName.TABLOID,

        MediaSizeName.LEDGER,

        MediaSizeName.NA_LEGAL,

        MediaSizeName.EXECUTIVE,

        MediaSizeName.ISO_A3,

        MediaSizeName.ISO_A4,

        MediaSizeName.ISO_A5,

        MediaSizeName.ISO_B4,

        MediaSizeName.ISO_B5,

    };

    private String printer;

    private PrinterName name;

    private boolean isInvalid;

    private transient PrintServiceAttributeSet lastSet;

    private transient ServiceNotifier notifier = null;

    UnixPrintService(String name) {

        if (name == null) {

            throw new IllegalArgumentException("null printer name");

        }

        printer = name;

        isInvalid = false;

    }

    public void invalidateService() {

        isInvalid = true;

    }

    public String getName() {

        return printer;

    }

    private PrinterName getPrinterName() {

        if (name == null) {

            name = new PrinterName(printer, null);

        }

        return name;

    }

    private PrinterIsAcceptingJobs getPrinterIsAcceptingJobsSysV() {

        String command = "/usr/bin/lpstat -a " + printer;

        String results[]= PrintServiceLookupProvider.execCmd(command);

        if (results != null && results.length > 0) {

            if (results[0].startsWith(printer + " accepting requests")) {

                return PrinterIsAcceptingJobs.ACCEPTING_JOBS;

            }

            else if (results[0].startsWith(printer)) {

                /* As well as "myprinter accepting requests", look for

                 * "myprinter@somehost accepting requests".

                 */

                int index = printer.length();

                String str = results[0];

                if (str.length() > index &&

                    str.charAt(index) == '@' &&

                    str.indexOf(" accepting requests", index) > 0 &&

                    str.indexOf(" not accepting requests", index) == -1) {

                   return PrinterIsAcceptingJobs.ACCEPTING_JOBS;

                }

            }

        }

        return PrinterIsAcceptingJobs.NOT_ACCEPTING_JOBS ;

    }

    private PrinterIsAcceptingJobs getPrinterIsAcceptingJobsBSD() {

        if (PrintServiceLookupProvider.cmdIndex ==

            PrintServiceLookupProvider.UNINITIALIZED) {

            PrintServiceLookupProvider.cmdIndex =

                PrintServiceLookupProvider.getBSDCommandIndex();

        }

        String command = "/usr/sbin/lpc status " + printer

            + lpcStatusCom[PrintServiceLookupProvider.cmdIndex];

        String results[]= PrintServiceLookupProvider.execCmd(command);

        if (results != null && results.length > 0) {

            if (PrintServiceLookupProvider.cmdIndex ==

                PrintServiceLookupProvider.BSD_LPD_NG) {

                if (results[0].startsWith("enabled enabled")) {

                    return PrinterIsAcceptingJobs.ACCEPTING_JOBS ;

                }

            } else {

                if ((results[1].trim().startsWith("queuing is enabled") &&

                    results[2].trim().startsWith("printing is enabled")) ||

                    (results.length >= 4 &&

                     results[2].trim().startsWith("queuing is enabled") &&

                     results[3].trim().startsWith("printing is enabled"))) {

                    return PrinterIsAcceptingJobs.ACCEPTING_JOBS ;

                }

            }

        }

        return PrinterIsAcceptingJobs.NOT_ACCEPTING_JOBS ;

    }

    // Filter the list of possible AIX Printers and remove header lines

    // and extra lines which have been added for remote printers.

    // 'protected' because this method is also used from PrintServiceLookupProvider.

    protected static String[] filterPrinterNamesAIX(String[] posPrinters) {

        ArrayList<String> printers = new ArrayList<>();

        String [] splitPart;

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

            // Remove the header lines

            if (posPrinters[i].startsWith("---") ||

                posPrinters[i].startsWith("Queue") ||

                posPrinters[i].equals("")) continue;

            // Check if there is a ":" in the end of the first colomn.

            // This means that it is not a valid printer definition.

            splitPart = posPrinters[i].split(" ");

            if(splitPart.length >= 1 && !splitPart[0].trim().endsWith(":")) {

                printers.add(posPrinters[i]);

            }

        }

        return printers.toArray(new String[printers.size()]);

    }

    private PrinterIsAcceptingJobs getPrinterIsAcceptingJobsAIX() {

        // On AIX there should not be a blank after '-a'.

        String command = "/usr/bin/lpstat -a" + printer;

        String results[]= PrintServiceLookupProvider.execCmd(command);

        // Remove headers and bogus entries added by remote printers.

        results = filterPrinterNamesAIX(results);

        if (results != null && results.length > 0) {

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

                if (results[i].contains("READY") ||

                    results[i].contains("RUNNING")) {

                    return PrinterIsAcceptingJobs.ACCEPTING_JOBS;

                }

            }

        }

        return PrinterIsAcceptingJobs.NOT_ACCEPTING_JOBS;

    }

    private PrinterIsAcceptingJobs getPrinterIsAcceptingJobs() {

        if (PrintServiceLookupProvider.isSysV()) {

            return getPrinterIsAcceptingJobsSysV();

        } else if (PrintServiceLookupProvider.isBSD()) {

            return getPrinterIsAcceptingJobsBSD();

        } else if (PrintServiceLookupProvider.isAIX()) {

            return getPrinterIsAcceptingJobsAIX();

        } else {

            return PrinterIsAcceptingJobs.ACCEPTING_JOBS;

        }

    }

    private PrinterState getPrinterState() {

        if (isInvalid) {

            return PrinterState.STOPPED;

        } else {

            return null;

        }

    }

    private PrinterStateReasons getPrinterStateReasons() {

        if (isInvalid) {

            PrinterStateReasons psr = new PrinterStateReasons();

            psr.put(PrinterStateReason.SHUTDOWN, Severity.ERROR);

            return psr;

        } else {

            return null;

        }

    }

    private QueuedJobCount getQueuedJobCountSysV() {

        String command = "/usr/bin/lpstat -R " + printer;

        String results[]= PrintServiceLookupProvider.execCmd(command);

        int qlen = (results == null) ? 0 : results.length;

        return new QueuedJobCount(qlen);

    }

    private QueuedJobCount getQueuedJobCountBSD() {

        if (PrintServiceLookupProvider.cmdIndex ==

            PrintServiceLookupProvider.UNINITIALIZED) {

            PrintServiceLookupProvider.cmdIndex =

                PrintServiceLookupProvider.getBSDCommandIndex();

        }

        int qlen = 0;

        String command = "/usr/sbin/lpc status " + printer

            + lpcQueueCom[PrintServiceLookupProvider.cmdIndex];

        String results[] = PrintServiceLookupProvider.execCmd(command);

        if (results != null && results.length > 0) {

            String queued;

            if (PrintServiceLookupProvider.cmdIndex ==

                PrintServiceLookupProvider.BSD_LPD_NG) {

                queued = results[0];

            } else {

                queued = results[3].trim();

                if (queued.startsWith("no")) {

                    return new QueuedJobCount(0);

                } else {

                    queued = queued.substring(0, queued.indexOf(' '));

                }

            }

            try {

                qlen = Integer.parseInt(queued);

            } catch (NumberFormatException e) {

            }

        }

        return new QueuedJobCount(qlen);

    }

    private QueuedJobCount getQueuedJobCountAIX() {

        // On AIX there should not be a blank after '-a'.

        String command = "/usr/bin/lpstat -a" + printer;

        String results[]=  PrintServiceLookupProvider.execCmd(command);

        // Remove headers and bogus entries added by remote printers.

        results = filterPrinterNamesAIX(results);

        int qlen = 0;

        if (results != null && results.length > 0){

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

                if (results[i].contains("QUEUED")){

                    qlen ++;

                }

            }

        }

        return new QueuedJobCount(qlen);

    }

    private QueuedJobCount getQueuedJobCount() {

        if (PrintServiceLookupProvider.isSysV()) {

            return getQueuedJobCountSysV();

        } else if (PrintServiceLookupProvider.isBSD()) {

            return getQueuedJobCountBSD();

        } else if (PrintServiceLookupProvider.isAIX()) {

            return getQueuedJobCountAIX();

        } else {

            return new QueuedJobCount(0);

        }

    }

    private PrintServiceAttributeSet getSysVServiceAttributes() {

        PrintServiceAttributeSet attrs = new HashPrintServiceAttributeSet();

        attrs.add(getQueuedJobCountSysV());

        attrs.add(getPrinterIsAcceptingJobsSysV());

        return attrs;

    }

    private PrintServiceAttributeSet getBSDServiceAttributes() {

        PrintServiceAttributeSet attrs = new HashPrintServiceAttributeSet();

        attrs.add(getQueuedJobCountBSD());

        attrs.add(getPrinterIsAcceptingJobsBSD());

        return attrs;

    }

    private PrintServiceAttributeSet getAIXServiceAttributes() {

        PrintServiceAttributeSet attrs = new HashPrintServiceAttributeSet();

        attrs.add(getQueuedJobCountAIX());

        attrs.add(getPrinterIsAcceptingJobsAIX());

        return attrs;

    }

    private boolean isSupportedCopies(Copies copies) {

        int numCopies = copies.getValue();

        return (numCopies > 0 && numCopies < MAXCOPIES);

    }

    private boolean isSupportedMedia(MediaSizeName msn) {

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

            if (msn.equals(mediaSizes[i])) {

                return true;

            }

        }

        return false;

    }

    public DocPrintJob createPrintJob() {

      SecurityManager security = System.getSecurityManager();

      if (security != null) {

        security.checkPrintJobAccess();

      }

        return new UnixPrintJob(this);

    }

    private PrintServiceAttributeSet getDynamicAttributes() {

        if (PrintServiceLookupProvider.isSysV()) {

            return getSysVServiceAttributes();

        } else if (PrintServiceLookupProvider.isAIX()) {

            return getAIXServiceAttributes();

        } else {

            return getBSDServiceAttributes();

        }

    }

    public PrintServiceAttributeSet getUpdatedAttributes() {

        PrintServiceAttributeSet currSet = getDynamicAttributes();

        if (lastSet == null) {

            lastSet = currSet;

            return AttributeSetUtilities.unmodifiableView(currSet);

        } else {

            PrintServiceAttributeSet updates =

                new HashPrintServiceAttributeSet();

            Attribute []attrs = currSet.toArray();

            Attribute attr;

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

                attr = attrs[i];

                if (!lastSet.containsValue(attr)) {

                    updates.add(attr);

                }

            }

            lastSet = currSet;

            return AttributeSetUtilities.unmodifiableView(updates);

        }

    }

    public void wakeNotifier() {

        synchronized (this) {

            if (notifier != null) {

                notifier.wake();

            }

        }

    }

    public void addPrintServiceAttributeListener(

                                 PrintServiceAttributeListener listener) {

        synchronized (this) {

            if (listener == null) {

                return;

            }

            if (notifier == null) {

                notifier = new ServiceNotifier(this);