#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# (c) Copyright 2003-2008 Hewlett-Packard Development Company, L.P.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
#
# Author: Don Welch
#

__version__ = '3.0'
__title__ = 'Printer Cartridge Cleaning Utility'
__doc__ = "Cartridge cleaning utility for HPLIP supported inkjet printers."

#Std Lib
import sys
import re
import getopt
import time
import operator
import os

# Local
from base.g import *
from base import device, utils, maint, tui
from prnt import cups

d = None

def CleanUIx(level):
    global d
    ok = tui.continue_prompt("Ready to perform level %d cleaning (Note: Wait for previous print to finish)." % level)
    
    if ok:
        timeout = 0
        time.sleep(5)
        
        try:
            while True:
                update_spinner()
                try:
                    d.open()
                except Error:
                    time.sleep(2)
                    timeout += 2
                    continue
                
                if d.isIdleAndNoError():
                    break
                
                time.sleep(1)
                timeout += 1
                
                if timeout > 45:
                    log.error("Timeout waiting for print to finish.")
                    sys.exit(0)
            
            
        finally:
            cleanup_spinner()
            d.close()
    
    return ok

def CleanUI1():
    log.note("Please wait for page to complete printing before continuing.")
    log.info("\nLevel 1 cleaning complete. If the printout looks OK, enter 'q' to quit or <enter> to do a level 2 cleaning.")
    return CleanUIx(2)
    
    
def CleanUI2():
    log.note("Please wait for page to complete printing before continuing.")
    log.info("\nLevel 2 cleaning complete. If the printout looks OK, enter 'q' to quit or <enter> to do a level 3 cleaning.")
    log.warn("Level 3 uses a lot of ink.")
    return CleanUIx(3)

def CleanUI3():
    log.info("\nLevel 3 cleaning complete. Check this page to see if the problem was fixed. If the test page was not printed OK, replace the print cartridge(s).")
    
    
USAGE = [(__doc__, "", "name", True),
         ("Usage: hp-clean [PRINTER|DEVICE-URI] [OPTIONS]", "", "summary", True),
         utils.USAGE_ARGS,
         utils.USAGE_DEVICE,
         utils.USAGE_PRINTER,
         utils.USAGE_SPACE,
         utils.USAGE_OPTIONS,
         utils.USAGE_BUS1, utils.USAGE_BUS2,
         utils.USAGE_LOGGING1, utils.USAGE_LOGGING2, utils.USAGE_LOGGING3,
         utils.USAGE_HELP,
         utils.USAGE_EXAMPLES,
         ("""Clean CUPS printer named 'hp5550':""", """$ hp-clean -php5550""",  "example", False),
         ("""Clean printer with URI of 'hp:/usb/DESKJET_990C?serial=12345':""", """$ hp-clean -dhp:/usb/DESKJET_990C?serial=12345""", 'example', False),
         utils.USAGE_SPACE,
         utils.USAGE_NOTES,
         utils.USAGE_STD_NOTES1, utils.USAGE_STD_NOTES2, 
         utils.USAGE_SEEALSO,
         ("hp-align", "", "seealso", False),
         ("hp-colorcal", "", "seealso", False),
         ]

    
         
def usage(typ='text'):
    if typ == 'text':
        utils.log_title(__title__, __version__)

    utils.format_text(USAGE, typ, __title__, 'hp-clean', __version__)
    sys.exit(0)

log.set_module("hp-clean")

try:

    try:
        opts, args = getopt.getopt(sys.argv[1:], 'p:d:hl:b:g',
                                    ['printer=', 'device=', 'help', 'help-rest', 'help-man', 
                                     'logging=', 'bus=', 'help-desc'])
    except getopt.GetoptError, e:
        log.error(e.msg)
        usage()

    bus = device.DEFAULT_PROBE_BUS
    log_level = logger.DEFAULT_LOG_LEVEL
    printer_name = None
    device_uri = None

    if os.getenv("HPLIP_DEBUG"):
        log.set_level('debug')

    for o, a in opts:
        if o in ('-h', '--help'):
            usage()

        elif o == '--help-rest':
            usage('rest')

        elif o == '--help-man':
            usage('man')

        elif o == '--help-desc':
            print __doc__,
            sys.exit(0)

        elif o in ('-p', '--printer'):
            if a.startswith('*'):
                printer_name = cups.getDefault()
            else:
                printer_name = a

        elif o in ('-d', '--device'):
            device_uri = a

        elif o in ('-b', '--bus'):
            bus = [x.lower().strip() for x in a.split(',')]
            if not device.validateBusList(bus):
                usage()

        elif o in ('-l', '--logging'):
            log_level = a.lower().strip()
            if not log.set_level(log_level):
                usage()

        elif o == '-g':
            log.set_level('debug')


    if os.getuid() == 0:
        log.error("hp-clean should not be run as root.")
    
    if not device.validateBusList(bus):
        usage()

    if device_uri and printer_name:
        log.error("You may not specify both a printer (-p) and a device (-d).")
        usage()

    utils.log_title(__title__, __version__)

    if not device_uri and not printer_name:
        try:
            device_uri = device.getInteractiveDeviceURI(bus, filter={'clean-type': (operator.gt, 0)})
            if device_uri is None:
                sys.exit(0)
        except Error:
            log.error("Error occured during interactive mode. Exiting.")
            sys.exit(0)

    try:
        d = device.Device(device_uri, printer_name)
    except Error, e:
        log.error("Unable to open device: %s" % e.msg)
        sys.exit(0)

    if d.device_uri is None and printer_name:
        log.error("Printer '%s' not found." % printer_name)
        sys.exit(0)

    if d.device_uri is None and device_uri:
        log.error("Malformed/invalid device-uri: %s" % device_uri)
        sys.exit(0)

    user_cfg.last_used.device_uri = d.device_uri

    if not d.cups_printers:
        log.error("No appropriate printer queue found for device. Please setup printer with hp-setup and try again.")
        sys.exit(1)

    try:
        try:
            d.open()
        except Error:
            log.error("Unable to print to printer. Please check device and try again.")
            sys.exit(1)

        if d.isIdleAndNoError():
            clean_type = d.mq.get('clean-type', 0)
            log.debug("Clean type=%d" % clean_type)
            d.close()

            try:
                if clean_type == CLEAN_TYPE_PCL:
                    maint.cleaning(d, clean_type, maint.cleanType1, maint.primeType1,
                                    maint.wipeAndSpitType1, tui.load_paper_prompt,
                                    CleanUI1, CleanUI2, CleanUI3,
                                    None)
        
                elif clean_type == CLEAN_TYPE_LIDIL:
                    maint.cleaning(d, clean_type, maint.cleanType2, maint.primeType2,
                                    maint.wipeAndSpitType2, tui.load_paper_prompt,
                                    CleanUI1, CleanUI2, CleanUI3,
                                    None)
        
                elif clean_type == CLEAN_TYPE_PCL_WITH_PRINTOUT:
                    maint.cleaning(d, clean_type, maint.cleanType1, maint.primeType1,
                                    maint.wipeAndSpitType1, tui.load_paper_prompt,
                                    CleanUI1, CleanUI2, CleanUI3,
                                    None)
            
                else:
                    log.error("Cleaning not needed or supported on this device.")
            
            except Error, e:
                log.error("An error occured: %s" % e[0])

        else:
            log.error("Device is busy or in an error state. Please check device and try again.")
            sys.exit(1)
    finally:
        d.close()

except KeyboardInterrupt:
    log.error("User exit")
    
log.info("")
log.info("Done.")

