#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# (c) Copyright 2003-2006 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__ = '1.2'
__title__ = 'Printer/Fax Setup Utility'
__doc__ = "Installs HPLIP printers and faxes in the CUPS spooler. Tries to automatically determine the correct PPD file to use. Allows the printing of a testpage. Performs basic fax parameter setup."

# Std Lib
import sys, getopt, time
import socket, os.path, re
import readline

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

    

USAGE = [ (__doc__, "", "name", True),
          ("Usage: hp-setup [OPTIONS] [SERIAL NO.|USB ID|IP|DEVNODE]", "", "summary", True),
          ("[SERIAL NO.|USB ID|IP|DEVNODE]", "", "heading", False),
          ("USB IDs (usb only):", """"xxx:yyy" where xxx is the USB bus ID and yyy is the USB device ID. The ':' must be present.""", 'option', False),
          ("", """Use the 'lsusb' command to obtain this information.""", "option", False),
          ("IPs (network only):", 'IPv4 address "a.b.c.d" or "hostname"', "option", False),
          ("DEVNODE (parallel only):", '"/dev/parportX", X=0,1,2,...', "option", False),
          ("SERIAL NO. (usb and parallel only):", '"serial no."', "option", True),
          utils.USAGE_OPTIONS,
          ("Automatic mode:", "-a or --auto", "option", False),
          ("No testpage in automatic mode:", "-x", "option", False),
          ("To specify a CUPS printer queue name:", "-n<printer> or --printer=<printer>", "option", False),
          ("To specify a CUPS fax queue name:", "-f<fax> or --fax=<fax>", "option", False),
          ("Type of queue(s) to install:", "-t<typelist> or --type=<typelist>. <typelist>: print*, fax\* (\*default)", "option", False),
          utils.USAGE_BUS1, utils.USAGE_BUS2,
          utils.USAGE_LOGGING1, utils.USAGE_LOGGING2,
          utils.USAGE_HELP,
          utils.USAGE_EXAMPLES,
          ("USB:", "$ hp-setup 001:002", "example", False),
          ("Network:", "$ hp-setup 66.35.250.209", "example", False),
          ("Parallel:", "$ hp-setup /dev/parport0", "example", False),
          ("USB or parallel:", "$ hp-setup US12345678A", "example", False),
          ("USB, automatic:", "$ hp-setup --auto 001:002", "example", False),
          ("Parallel, automatic, no testpage:", "$ hp-setup -a -x /dev/parport0", "example", False),
          ("Parallel, choose device:", "$ hp-setup -b par", "example", False),
          utils.USAGE_SPACE,
          utils.USAGE_NOTES,
          ("1. If no serial number, USB ID, IP, or device node is specified, the USB and parallel busses will be probed for devices.", "", 'note', False),
          ("2. Using 'lsusb' to obtain USB IDs: (example)", "", 'note', False),
          ("   $ lsusb", "", 'note', False),
          ("   Bus 003 Device 011: ID 03f0:c202 Hewlett-Packard", "", 'note', False),
          ("   $ hp-setup --auto 003:011", "", 'note', False),
          ("   (Note: You may have to run 'lsusb' from /sbin or another location. Use '$ locate lsusb' to determine this.)", "", 'note', True),
          utils.USAGE_SEEALSO,
          ("hp-makeuri", "", "seealso", True),
        ]

def usage(typ='text'):
    if typ == 'text':
        utils.log_title(__title__, __version__)
        
    utils.format_text(USAGE, typ, __title__, 'hp-setup', __version__)
    sys.exit(0)


try:
    opts, args = getopt.getopt(sys.argv[1:], 'p:n:d:hl:b:t:f:ax',
        ['printer=', 'fax=', 'device=', 'help', 'help-rest', 'help-man',
         'logging=', 'bus=', 'type=', 'auto', 'port='])
except getopt.GetoptError:
    usage()

printer_name = None
fax_name = None
device_uri = None
log_level = logger.DEFAULT_LOG_LEVEL
bus = device.DEFAULT_PROBE_BUS
setup_print = True
setup_fax = True
makeuri = None
bus="cups,par,usb"
auto=False
testpage_in_auto_mode = True
jd_port = 1

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

for o, a in opts:
    if o in ('-h', '--help'):
        usage('text')
    
    elif o == '--help-rest':
        usage('rest')
        
    elif o == '--help-man':
        usage('man')

    elif o == '-x':
        testpage_in_auto_mode = False
    
    elif o in ('-n', '--printer'):
        printer_name = a

    elif o in ('-f', '--fax'):
        fax_name = a

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

    elif o in ('-b', '--bus'):
        bus = a.lower().strip()
        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 in ('-t', '--type'):
        setup_fax, setup_print = False, False
        a = a.strip().lower()
        for aa in a.split(','):
            if aa.strip() not in ('print', 'fax'):
                usage()
            if aa.strip() == 'print':
                setup_print = True
            elif aa.strip() == 'fax':
                setup_fax = True
                
    elif o in ('-p', '--port'):
        try:
            jd_port = int(a)
        except ValueError:
            log.error("Invalid port number. Must be between 1 and 3 inclusive.")
            usage()
        
    elif o in ('-a', '--auto'):
        auto = True


utils.log_title(__title__, __version__)


if not os.geteuid() == 0:
    log.error("You must be root to run this utility.")
    sys.exit(1)

hpiod_sock = None
try:
    hpiod_sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    hpiod_sock.connect((prop.hpiod_host, prop.hpiod_port))
except socket.error:
    log.error("Unable to connect to hpiod.")
    sys.exit(1)


hpssd_sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
try:
    hpssd_sock.connect((prop.hpssd_host, prop.hpssd_port))
except socket.error:
    print "Unable to connect to HPLIP I/O (hpssd)."
    sys.exit(1)
    
# ******************************* MAKEURI
    
if len(args):
    param = args[0]
    device_uri, sane_uri, fax_uri = device.makeuri(hpiod_sock, hpssd_sock, param, jd_port)
        
# ******************************* DEVICE CHOOSER
      
if not device_uri: 
    try:
        device_uri = device.getInteractiveDeviceURI(bus)
        if device_uri is None:
            sys.exit(1)
    except Error:
        log.error("Error occured during interactive mode. Exiting.")
        sys.exit(1)

# ******************************* QUERY MODEL AND COLLECT PPDS

log.info("")
if not auto:
    log.info("(Note: Defaults for each question are maked with a '*'. Press <enter> to accept the default.)")

log.info("")
        
print_uri = device_uri.replace("hpfax:", "hp:")
fax_uri = device_uri.replace("hp:", "hpfax:")

back_end, is_hp, bus, model, \
    serial, dev_file, host, port = \
    device.parseDeviceURI(device_uri)

log.debug("Model=%s" % model)
        
mq, data, result_code = msg.xmitMessage(hpssd_sock, "QueryModel", payload=None,
                                        other_fields={"device-uri": device_uri},
                                        timeout=prop.read_timeout)

if not mq['fax-type'] and setup_fax:
    log.warning("Cannot setup fax - device does not have fax feature.")
    setup_fax = False
    
log.debug("Searching for PPDs in: %s" % sys_cfg.dirs.ppd)
ppds = []    
for f in utils.walkFiles(sys_cfg.dirs.ppd, pattern="HP*ppd*", abs_paths=True):
    ppds.append(f)

default_model = model.replace('series', '').replace('Series', '').strip('_')
stripped_model = default_model.replace('HP-', '').replace('HP_', '').lower()

# ******************************* PRINT QUEUE SETUP

if setup_print:
    installed_print_devices = device.getSupportedCUPSDevices(['hp'])  
    log.debug(installed_print_devices)
    
    if not auto and print_uri in installed_print_devices:
        log.warning("A print queue already exists for this device.")
        while True:
            user_input = raw_input(utils.bold("\nWould you like to install another print queue for this device? (y=yes, n=no*, q=quit) ?" ))
            user_input = user_input.lower().strip()
            
            if not user_input:
                user_input = 'n'
            
            setup_print = (user_input == 'y')
            
            if user_input in ('q', 'y', 'n'):
                break
                
            log.error("Please enter 'y', 'n' or 'q'")
            
        if user_input == 'q':
            log.info("OK, done.")
            sys.exit(0)

            
    
if setup_print:
    log.info(utils.bold("\nPRINT QUEUE SETUP"))
    
    if auto:
        printer_name = default_model
    else:
        if printer_name is None:
            while True:
                printer_name = raw_input(utils.bold("\nPlease enter a name for this print queue (m=use model name:'%s'*, q=quit) ?" % default_model))
                
                if printer_name.lower().strip() == 'q':
                    log.info("OK, done.")
                    sys.exit(0)
                    
                if not printer_name or printer_name.lower().strip() == 'm':
                    printer_name = default_model
                    
                name_ok = True
                
                if print_uri in installed_print_devices:
                    for d in installed_print_devices[print_uri]:
                        if printer_name in d:
                            log.error("A print queue with that name already exists. Please enter a different name.")
                            name_ok = False
                
                # TODO: Validate chars in name
                
                if name_ok:
                    break
    
    
    log.info("Using queue name: %s" % printer_name)
    
    mins = []
    eds = {}
    min_edit_distance = sys.maxint
    
    
    for f in ppds:
        t = os.path.basename(f).replace('HP-', '').replace('-hpijs', '').\
            replace('.gz', '').replace('.ppd', '').replace('HP_', '').lower()
            
        
        eds[f] = utils.levenshtein_distance(stripped_model, t)
        log.debug("dist('%s', '%s') = %d" % (stripped_model, t, eds[f]))
        min_edit_distance = min(min_edit_distance, eds[f])
        
    for f in ppds:
        if eds[f] == min_edit_distance:
            for m in mins:
                if os.path.basename(m) == os.path.basename(f):
                    break # File already in list possibly with different path (Ubuntu, etc)
            else:
                mins.append(f)
    
    x = len(mins)     

    if x == 0:
        log.error("Unable to find PPD file. Please download and install an appropriate PPD file and try again.")
        sys.exit(1)
        
    elif x == 1:
        print_ppd = mins[0]
        log.info("\nFound a possible PPD file: %s" % print_ppd)
        
        if not auto:
            while True:
                log.info("Note: The model number may vary slightly from the actual model number on the device.")
                user_input = raw_input(utils.bold("\nDoes this PPD file appear to be the correct one (y=yes*, n=no, q=quit) ?"))
                user_input = user_input.strip().lower()
                
                if user_input == 'q':
                    log.info("OK, done.")
                    sys.exit(0)
                
                if not user_input or user_input == 'y':
                    break
                    
                if user_input == 'n':
                    log.error("Unable to find PPD file. Please download and install an appropriate PPD file and try again.")
                    sys.exit(1)
                    
                log.error("Please enter 'y' or 'n'")
                
    else:
        log.info("")
        log.warn("Found multiple possible PPD files")
        
        max_ppd_filename_size = 0
        for p in mins:
            max_ppd_filename_size = max(len(p), max_ppd_filename_size)
        
        log.info(utils.bold("\nChoose a PPD file that most closely matches your device:"))
        log.info("(Note: The model number may vary slightly from the actual model number on the device.)\n")
        
        formatter = utils.TextFormatter(
                (
                    {'width': 4},
                    {'width': max_ppd_filename_size, 'margin': 2},
                )
            )
        
        log.info(formatter.compose(("Num.", "PPD Filename")))
        log.info(formatter.compose(('-'*4, '-'*(max_ppd_filename_size), )))
    
        for y in range(x):
            log.info(formatter.compose((str(y), mins[y])))
            
        x += 1
        none_of_the_above = y+1
        log.info(formatter.compose((str(none_of_the_above), "(None of the above match)")))

        while 1:
            user_input = raw_input(utils.bold("\nEnter number 0...%d for PPD file (q=quit) ?" % (x-1)))
            user_input = user_input.strip().lower()
            
            if user_input == '':
                log.warn("Invalid input - enter a numeric value or 'q' to quit.")
                continue

            if user_input == 'q':
                log.info("OK, done.")
                sys.exit(0)

            try:
                i = int(user_input)
            except ValueError:
                log.warn("Invalid input - enter a numeric value or 'q' to quit.")
                continue
                
            if i == none_of_the_above:
                log.error("Unable to match PPD file. Please download and install an appropriate PPD file and try again.")
                sys.exit(1)
                
            if i < 0 or i > (x-1):
                log.warn("Invalid input - enter a value between 0 and %d or 'q' to quit." % (x-1))
                continue

            break

        print_ppd = mins[i]             
    
    
    if auto:
        location, info = '', 'Automatically setup by HPLIP'
    else:
        while True:
            location = raw_input(utils.bold("Enter a location description for this printer (q=quit) ?"))
            
            if location.strip().lower() == 'q':
                log.info("OK, done.")
                sys.exit(0)
            
            # TODO: Validate chars
            
            break
        
        while True:
            info = raw_input(utils.bold("Enter additonal information or notes for this printer (q=quit) ?"))
            
            if info.strip().lower() == 'q':
                log.info("OK, done.")
                sys.exit(0)
            
            # TODO: Validate chars
            
            break
    
    log.info(utils.bold("\nAdding print queue to CUPS:"))
    log.info("Device URI: %s" % print_uri)
    log.info("Queue name: %s" % printer_name)
    log.info("PPD file: %s" % print_ppd)
    log.info("Location: %s" % location)
    log.info("Information: %s" % info)

    cups.addPrinter(printer_name, print_uri, location, print_ppd, info)
    
# ******************************* TEST PAGE    
    
    print_test_page = False
    
    if auto:
        if testpage_in_auto_mode:
            print_test_page = True
    else:
        while True:
            user_input = raw_input(utils.bold("\nWould you like to print a test page (y=yes*, n=no, q=quit) ?"))
            user_input = user_input.strip().lower()
            
            if not user_input:
                user_input = 'y'
            
            if user_input == 'q':
                log.info("OK, done.")
                sys.exit(0)
            
            print_test_page = (user_input == 'y')
            
            if user_input in ('y', 'n', 'q'):
                break
            
            log.error("Please enter 'y' or 'n'")
            
    if print_test_page:
        if not auto:
            user_input = raw_input(utils.bold("\nLoad plain paper into printer and press 'enter' ?"))
    
        d = device.Device(print_uri)
        
        try:
            try:
                d.open()
            except Error:
                log.error("Unable to print to printer. Please check device and try again.")
            else:
                if d.isIdleAndNoError():
                    d.close()
                    log.info( "Printing test page..." )
                    d.printTestPage()
                
                    log.info("Test page has been sent to printer...")
                
                else:
                    log.error("Unable to print to printer. Please check device and try again.")
                
        finally:
            d.close()
    
    
# ******************************* FAX QUEUE SETUP

if setup_fax:
    try:
        from fax import fax
    except ImportError:
        # This can fail on Python < 2.3 due to the datetime module
        setup_fax = False
        log.warning("Fax setup disabled - Python 2.3+ required.")
    
log.info("")

if setup_fax:
    log.info(utils.bold("\nFAX QUEUE SETUP"))
    installed_fax_devices = device.getSupportedCUPSDevices(['hpfax'])    
    log.debug(installed_fax_devices)
    
    if not auto and fax_uri in installed_fax_devices:
        log.warning("One or more fax queues already exist for this device: %s." % ', '.join(installed_fax_devices[fax_uri]))
        while True:
            user_input = raw_input(utils.bold("\nWould you like to install another fax queue for this device? (y=yes, n=no*, q=quit) ?"))
            user_input = user_input.lower().strip()
            
            if not user_input:
                user_input = 'n'
                
            setup_fax = (user_input == 'y')                
            
            if user_input in ('q', 'y', 'n'):
                break
                
            log.error("Please enter 'y', 'n' or 'q'")
    
        if user_input == 'q':
            log.info("OK, done.")
            sys.exit(0)
            
        
if setup_fax:
    #log.info(utils.bold("\nSetting up fax queue..."))

    if auto:
        fax_name = default_model + '_fax'
    else:
        if fax_name is None:
            while True:
                fax_name = raw_input(utils.bold("\nPlease enter a name for this fax queue (m=use model name:'%s'*, q=quit) ?" % (default_model+'_fax')))
                
                if fax_name.lower().strip() == 'q':
                    log.info("OK, done.")
                    sys.exit(0)
                
                if not fax_name or fax_name.lower().strip() == 'm':
                    fax_name = default_model + '_fax'
                    
                name_ok = True
                
                if fax_uri in installed_fax_devices:
                    for d in installed_fax_devices[fax_uri]:
                        if fax_name in d:
                            log.error("A fax queue with that name already exists. Please enter a different name.")
                            name_ok = False
                        
                # TODO: Validate chars in name
                
                if name_ok:
                    break

    log.info("Using queue name: %s" % fax_name)

    for f in ppds:
        if f.find('HP-Fax') >= 0:
            fax_ppd = f
            log.debug("Found PDD file: %s" % fax_ppd)
            break
    else:
        log.error("Unable to find HP fax PPD file! Please check you HPLIP installation and try again.")
        sys.exit(1)
    
    
    if auto:
        location, info = '', 'Automatically setup by HPLIP'
    else:
        while True:
            location = raw_input(utils.bold("Enter a location description for this printer (q=quit) ?"))
            
            if location.strip().lower() == 'q':
                log.info("OK, done.")
                sys.exit(0)
            
            # TODO: Validate chars
            
            break
        
        while True:
            info = raw_input(utils.bold("Enter additonal information or notes for this printer (q=quit) ?"))
            
            if info.strip().lower() == 'q':
                log.info("OK, done.")
                sys.exit(0)
            
            # TODO: Validate chars
            
            break
    
    
    log.info(utils.bold("\nAdding fax queue to CUPS:"))
    log.info("Device URI: %s" % fax_uri)
    log.info("Queue name: %s" % fax_name)
    log.info("PPD file: %s" % fax_ppd)
    log.info("Location: %s" % location)
    log.info("Information: %s" % info)

    cups.addPrinter(fax_name, fax_uri, location, fax_ppd, info)

# ******************************* FAX HEADER SETUP
    
    if auto:
        setup_fax = False
    else:
        while True:
            user_input = raw_input(utils.bold("\nWould you like to perform fax header setup (y=yes*, n=no, q=quit) ?"))
            user_input = user_input.strip().lower()
            
            if user_input == 'q':
                log.info("OK, done.")
                sys.exit(0)
            
            if not user_input:
                user_input = 'y'
            
            setup_fax = (user_input == 'y')
            
            if user_input in ('y', 'n', 'q'):
                break
            
            log.error("Please enter 'y' or 'n'")
            
    if setup_fax:
        d = fax.FaxDevice(fax_uri)
        
        try:
            d.open()
        except Error:
            log.error("Unable to communicate with the device. Please check the device and try again.")
        else:
            try:
                tries = 0
                ok = True
                
                while True:
                    tries += 1
                    
                    try:
                        current_phone_num = d.getPhoneNum()
                        current_station_name = d.getStationName()
                    except Error:
                        log.error("Could not communicate with device. Device may be busy. Please wait for retry...")
                        time.sleep(5)
                        ok = False
                        
                        if tries > 12:
                            break
                            
                    else:
                        ok = True
                        break
                        
                if ok:
                    while True:
                        if current_phone_num:
                            phone_num = raw_input(utils.bold("\nEnter the fax phone number for this device (c=use current:'%s'*, q=quit) ?" % current_phone_num))
                        else:
                            phone_num = raw_input(utils.bold("\nEnter the fax phone number for this device (q=quit) ?"))
                            
                        if current_phone_num and phone_num.strip().lower() == 'c':
                            phone_num = current_phone_num
                        
                        if phone_num.strip().lower() == 'q':
                            log.info("OK, done.")
                            sys.exit(0)
                            
                        if len(phone_num) > 50:
                            log.error("Phone number length is too long (>50 characters). Please enter a shorter number.")
                            continue
                            
                        ok = True
                        for x in phone_num:
                            if x not in '0123456789-(+) ':
                                log.error("Invalid characters in phone number. Please only use 0-9, -, (, +, and )")
                                ok = False
                                break
                        
                        if not ok:
                            continue
                        
                        break
                    
                    while True:
                        if current_station_name:
                            station_name = raw_input(utils.bold("\nEnter the name and/or company for this device (c=use current:'%s'*, q=quit) ?" % current_station_name))
                        else:
                            station_name = raw_input(utils.bold("\nEnter the name and/or company for this device (q=quit) ?"))
                        
                        if current_station_name and station_name.strip().lower() == 'c':
                            station_name = current_station_name
                        
                        if station_name.strip().lower() == 'q':
                            log.info("OK, done.")
                            sys.exit(0)
                        
                        if len(station_name) > 50:
                            log.error("Name/company length is too long (>50 characters). Please enter a shorter name/company.")
                            continue
                        
                        break
                    
            
                    try:
                        d.setStationName(station_name)
                        d.setPhoneNum(phone_num)
                    except Error:
                        log.error("Could not communicate with device. Device may be busy.")
                    else:
                        log.info("\nParameters sent to device.")
            
            finally:
                d.close()
    
log.info("\nDone.")
sys.exit(0)

