home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / hplip / align.py < prev    next >
Encoding:
Python Source  |  2008-10-13  |  10.7 KB  |  340 lines
  1. #!/usr/bin/env python
  2. # -*- coding: utf-8 -*-
  3. #
  4. # (c) Copyright 2003-2008 Hewlett-Packard Development Company, L.P.
  5. #
  6. # This program is free software; you can redistribute it and/or modify
  7. # it under the terms of the GNU General Public License as published by
  8. # the Free Software Foundation; either version 2 of the License, or
  9. # (at your option) any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. # GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with this program; if not, write to the Free Software
  18. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19. #
  20. # Author: Don Welch
  21. #
  22.  
  23. __version__ = '4.2'
  24. __title__ = 'Printer Cartridge Alignment Utility'
  25. __doc__ = "Cartridge alignment utility for HPLIP supported inkjet printers."
  26.  
  27. # Std Lib
  28. import sys
  29. import re
  30. import getopt
  31. import operator
  32. import os
  33.  
  34. # Local
  35. from base.g import *
  36. from base import device, status, utils, maint, tui
  37. from prnt import cups
  38.  
  39.  
  40.  
  41. USAGE = [(__doc__, "", "name", True),
  42.          ("""Usage: hp-align [PRINTER|DEVICE-URI] [OPTIONS]""", "", "summary", True),
  43.          utils.USAGE_ARGS,
  44.          utils.USAGE_DEVICE,
  45.          utils.USAGE_PRINTER,
  46.          utils.USAGE_SPACE,
  47.          utils.USAGE_OPTIONS,
  48.          utils.USAGE_BUS1, utils.USAGE_BUS2,
  49.          utils.USAGE_LOGGING1, utils.USAGE_LOGGING2, utils.USAGE_LOGGING3,
  50.          utils.USAGE_HELP,
  51.          utils.USAGE_EXAMPLES,
  52.          ("""Align CUPS printer named 'hp5550':""", """$ hp-align -php5550""",  "example", False),
  53.          ("""Align printer with URI of 'hp:/usb/DESKJET_990C?serial=12345':""", """$ hp-align -dhp:/usb/DESKJET_990C?serial=12345""", 'example', False),
  54.          utils.USAGE_SPACE,
  55.          utils.USAGE_NOTES,
  56.          utils.USAGE_STD_NOTES1, utils.USAGE_STD_NOTES2, 
  57.          utils.USAGE_SEEALSO,
  58.          ("hp-clean", "", "seealso", False),
  59.          ("hp-colorcal", "", "seealso", False),
  60.          ]
  61.  
  62.  
  63. def usage(typ='text'):
  64.     if typ == 'text':
  65.         utils.log_title(__title__, __version__)
  66.  
  67.     utils.format_text(USAGE, typ, __title__, 'hp-align', __version__)
  68.     sys.exit(0)
  69.  
  70.     
  71. def enterAlignmentNumber(letter, hortvert, colors, line_count, maximum):
  72.     ok, value = tui.enter_range("Enter the best aligned value for line %s (1-%d): " % 
  73.                         (letter, maximum),
  74.                         1,
  75.                         maximum)
  76.                         
  77.     if not ok:
  78.         sys.exit(0)
  79.         
  80.     return ok, value
  81.  
  82.     
  83. def enterPaperEdge(maximum):
  84.     ok, value = tui.enter_range("Enter numbered arrow that is best aligned with the paper edge (1-%d): " 
  85.                         % maximum,
  86.                         1,
  87.                         maximum)
  88.     if not ok:
  89.         sys.exit(0)
  90.         
  91.     return ok, value
  92.     
  93.  
  94. def colorAdj(line, maximum):
  95.     ok, value = tui.enter_range("Enter the numbered box on line %s that is best color matched to the background color (1-%d): " % 
  96.                         (line, maximum),
  97.                         1,
  98.                         maximum)
  99.     if not ok:
  100.         sys.exit(0)
  101.         
  102.     return ok, value
  103.  
  104.     
  105. def bothPensRequired():
  106.     log.error("Cannot perform alignment with 0 or 1 cartridges installed.\nPlease install both cartridges and try again.")
  107.  
  108.     
  109. def invalidPen():
  110.     log.error("Invalid cartridge(s) installed.\nPlease install valid cartridges and try again.")
  111.  
  112.     
  113. def invalidPen2():
  114.     log.error("Invalid cartridge(s) installed. Cannot align with only the photo cartridge installed.\nPlease install other cartridges and try again.")
  115.  
  116.     
  117. def aioUI1():
  118.     log.info("To perform alignment, you will need the alignment page that is automatically\nprinted after you install a print cartridge.")
  119.     log.info("\np\t\tPrint the alignment page and continue.")
  120.     log.info("n\t\tDo Not print the alignment page (you already have one) and continue.")
  121.     log.info("q\t\tQuit.\n")
  122.  
  123.     ok, choice = tui.enter_choice("Choice (p=print page*, n=do not print page, q=quit) ? ", ['p', 'n', 'q'], 'p')
  124.     
  125.     if choice == 'q':
  126.         sys.exit(0)
  127.     
  128.     return choice == 'y'
  129.  
  130.     
  131. def type10and11Align(pattern, align_type):
  132.     controls = maint.align10and11Controls(pattern, align_type)
  133.     values = []
  134.     s_controls = controls.keys()
  135.     s_controls.sort()
  136.  
  137.     for line in s_controls:
  138.         if not controls[line][0]:
  139.             values.append(0)
  140.         else:
  141.             ok, value = tui.enter_range("Enter the numbered box on line %s where the inner lines best line up with the outer lines (1-%d): " 
  142.                 % (line, controls[line][1]),  1, controls[line][1])
  143.             values.append(value)
  144.             
  145.             if not ok:
  146.                 sys.exit(0)
  147.  
  148.     return values
  149.  
  150.  
  151. def aioUI2():
  152.     log.info("")
  153.     log.info(log.bold("Follow these steps to complete the alignment:"))
  154.     log.info("1. Place the alignment page, with the printed side facing down, ")
  155.     log.info("   in the scanner.")
  156.     log.info("2. Press the Enter or Scan button on the printer.")
  157.     log.info('3. "Alignment Complete" will be displayed when the process is finished (on some models).')
  158.  
  159.  
  160.     
  161.     
  162. try:    
  163.     try:
  164.         opts, args = getopt.getopt(sys.argv[1:],
  165.                                     'p:d:hl:b:ag',
  166.                                     ['printer=',
  167.                                       'device=',
  168.                                       'help',
  169.                                       'help-rest',
  170.                                       'help-man',
  171.                                       'help-desc',
  172.                                       'logging=',
  173.                                       'bus='
  174.                                     ]
  175.                                   )
  176.     except getopt.GetoptError, e:
  177.         log.error(e.msg)
  178.         usage()
  179.  
  180.     log.set_module("hp-align")
  181.  
  182.     printer_name = None
  183.     device_uri = None
  184.     bus = device.DEFAULT_PROBE_BUS
  185.     log_level = logger.DEFAULT_LOG_LEVEL
  186.     align_debug = False
  187.  
  188.     if os.getenv("HPLIP_DEBUG"):
  189.         log.set_level('debug')
  190.  
  191.     for o, a in opts:
  192.         if o in ('-h', '--help'):
  193.             usage()
  194.  
  195.         elif o == '--help-rest':
  196.             usage('rest')
  197.  
  198.         elif o == '--help-man':
  199.             usage('man')
  200.  
  201.         elif o == '--help-desc':
  202.             print __doc__,
  203.             sys.exit(0)
  204.  
  205.         elif o in ('-p', '--printer'):
  206.             if a.startswith('*'):
  207.                 printer_name = cups.getDefaultPrinter()
  208.                 log.debug(printer_name)
  209.                 
  210.                 if printer_name is not None:
  211.                     log.info("Using CUPS default printer: %s" % printer_name)
  212.                 else:
  213.                     log.error("CUPS default printer is not set.")
  214.                 
  215.             else:
  216.                 printer_name = a
  217.  
  218.         elif o in ('-d', '--device'):
  219.             device_uri = a
  220.  
  221.         elif o in ('-b', '--bus'):
  222.             bus = [x.lower().strip() for x in a.split(',')]
  223.             if not device.validateBusList(bus):
  224.                 usage()
  225.  
  226.         elif o in ('-l', '--logging'):
  227.             log_level = a.lower().strip()
  228.             if not log.set_level(log_level):
  229.                 usage()
  230.  
  231.         elif o == '-g':
  232.             log.set_level('debug')
  233.  
  234.         elif o == '-a':
  235.             align_debug = True
  236.  
  237.  
  238.  
  239.     if device_uri and printer_name:
  240.         log.error("You may not specify both a printer (-p) and a device (-d).")
  241.         usage()
  242.  
  243.     utils.log_title(__title__, __version__)
  244.     
  245.     if os.getuid() == 0:
  246.         log.warn("hp-align should not be run as root.")
  247.  
  248.     if not device_uri and not printer_name:
  249.         try:
  250.             device_uri = device.getInteractiveDeviceURI(bus, filter={'align-type': (operator.gt, 0)})
  251.             if device_uri is None:
  252.                 sys.exit(0)
  253.         except Error:
  254.             log.error("Error occured during interactive mode. Exiting.")
  255.             sys.exit(0)
  256.  
  257.     try:
  258.         d = device.Device( device_uri, printer_name )
  259.     except Error, e:
  260.         log.error("Unable to open device: %s" % e.msg)
  261.         sys.exit(0)
  262.  
  263.     if d.device_uri is None and printer_name:
  264.         log.error("Printer '%s' not found." % printer_name)
  265.         sys.exit(0)
  266.  
  267.     if d.device_uri is None and device_uri:
  268.         log.error("Malformed/invalid device-uri: %s" % device_uri)
  269.         sys.exit(0)
  270.         
  271.     user_cfg.last_used.device_uri = d.device_uri
  272.  
  273.     if not d.cups_printers:
  274.         log.error("No appropriate printer queue found for device. Please setup printer with hp-setup and try again.")
  275.         sys.exit(1)
  276.  
  277.     try:
  278.         try:
  279.             d.open()
  280.         except Error:
  281.             log.error("Device is busy or in an error state. Please check device and try again.")
  282.             sys.exit(1)
  283.  
  284.         if d.isIdleAndNoError():
  285.             align_type = d.mq.get('align-type', 0)
  286.             log.debug("Alignment type=%d" % align_type)
  287.             d.close()
  288.  
  289.             if align_type == ALIGN_TYPE_NONE:
  290.                 log.error("Alignment not supported or required by device.")
  291.                 sys.exit(0)
  292.  
  293.             if align_type == ALIGN_TYPE_AUTO:
  294.                 maint.AlignType1PML(d, tui.load_paper_prompt)
  295.  
  296.             elif align_type == ALIGN_TYPE_8XX:
  297.                 maint.AlignType2(d, tui.load_paper_prompt, enterAlignmentNumber,
  298.                                   bothPensRequired)
  299.  
  300.             elif align_type in (ALIGN_TYPE_9XX,ALIGN_TYPE_9XX_NO_EDGE_ALIGN):
  301.                 maint.AlignType3(d, tui.load_paper_prompt, enterAlignmentNumber,
  302.                                   enterPaperEdge, update_spinner)
  303.  
  304.             elif align_type == ALIGN_TYPE_LIDIL_AIO:
  305.                 maint.AlignType6(d, aioUI1, aioUI2, tui.load_paper_prompt)
  306.  
  307.             elif align_type == ALIGN_TYPE_DESKJET_450:
  308.                 maint.AlignType8(d, tui.load_paper_prompt, enterAlignmentNumber)
  309.  
  310.             elif align_type in (ALIGN_TYPE_LIDIL_0_3_8, ALIGN_TYPE_LIDIL_0_4_3, ALIGN_TYPE_LIDIL_VIP):
  311.  
  312.                 maint.AlignxBow(d, align_type, tui.load_paper_prompt, enterAlignmentNumber, enterPaperEdge,
  313.                                  invalidPen, colorAdj)
  314.  
  315.             elif align_type  == ALIGN_TYPE_LBOW:
  316.                 maint.AlignType10(d, tui.load_paper_prompt, type10and11Align)
  317.  
  318.             elif align_type == ALIGN_TYPE_LIDIL_0_5_4:
  319.                 maint.AlignType11(d, tui.load_paper_prompt, type10and11Align, invalidPen2)
  320.                 
  321.             elif align_type == ALIGN_TYPE_OJ_PRO:
  322.                 maint.AlignType12(d, tui.load_paper_prompt)
  323.                 
  324.  
  325.             else:
  326.                 log.error("Invalid alignment type.")
  327.  
  328.         else:
  329.             log.error("Device is busy or in an error state. Please check device and try again.")
  330.  
  331.     finally:
  332.         d.close()
  333.  
  334. except KeyboardInterrupt:
  335.     log.error("User exit")
  336.  
  337.  
  338. log.info("")
  339. log.info('Done.')
  340.