summaryrefslogtreecommitdiff
path: root/makeuri.py
blob: 260bde6f33eda8d09b45c6036b4052d0fc7e71eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# (c) Copyright 2003-2007 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
#
# Authors: Don Welch, Smith Kennedy
#

__version__ = '4.4'
__title__ = 'Device URI Creation Utility'
__doc__ = "Creates device URIs for local and network connected printers for use with CUPS."

# Std Lib
import sys
import re
import getopt
import os

# Local
from base.g import *
from base.codes import *
from base import device, utils


USAGE = [ (__doc__, "", "name", True),
          ("Usage: hp-makeuri [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 ':' and all leading zeroes must be present.""", 'option', False),
          ("", """(Use the 'lsusb' command to obtain this information. See Note 1.)""", "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,
          ("To specify the port on a multi-port JetDirect:", "-p<port> or --port=<port> (Valid values are 1\*, 2, and 3. \*default)", "option", False),
          ("Show the CUPS URI only (quiet mode):", "-c or --cups", "option", False),
          ("Show the SANE URI only (quiet mode):", "-s or --sane", "option", False),
          ("Show the HP Fax URI only (quiet mode):", "-f or --fax", "option", False),
          utils.USAGE_LOGGING1, utils.USAGE_LOGGING2, utils.USAGE_LOGGING3,
          utils.USAGE_HELP,
          utils.USAGE_EXAMPLES,
          ("USB:", "$ hp-makeuri 001:002", "example", False),
          ("Network:", "$ hp-makeuri 66.35.250.209", "example", False),
          ("Parallel:", "$ hp-makeuri /dev/parport0", "example", False),
          ("USB or parallel (using serial number):", "$ hp-makeuri US123456789", "example", False),
          utils.USAGE_SPACE,
          utils.USAGE_NOTES,
          ("1. Example using 'lsusb' to obtain USB bus ID and USB device ID (example only, the values you obtain will differ) :", "", 'note', False),
          ("   $ lsusb", "", 'note', False),
          ("   Bus 003 Device 011: ID 03f0:c202 Hewlett-Packard", "", 'note', False),
          ("   $ hp-makeuri 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_SPACE,
          utils.USAGE_SEEALSO,
          ("hp-setup", "", "seealso", False),
        ]

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

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



log.set_module('hp-makeuri')
try:
    try:
        opts, args = getopt.getopt(sys.argv[1:], 
                                    'hl:csfp:g', 
                                    ['help', 'help-rest', 'help-man', 'help-desc',
                                      'logging=',
                                      'cups',
                                      'sane',
                                      'fax',
                                      'port=',
                                    ] 
                                  ) 
    except getopt.GetoptError, e:
        log.error(e.msg)
        usage()
        sys.exit(1)

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

    log_level = 'info'
    cups_quiet_mode = False
    sane_quiet_mode = False
    fax_quiet_mode = False
    jd_port = 1

    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 ('-l', '--logging'):
            log_level = a.lower().strip()
            if not log.set_level(log_level):
                usage()

        elif o in ('-c', '--cups'):
            cups_quiet_mode = True

        elif o in ('-s', '--sane'):
            sane_quiet_mode = True

        elif o in ('-f', '--fax'):
            fax_quiet_mode = 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 == '-g':
            log.set_level('debug')


    quiet_mode = cups_quiet_mode or sane_quiet_mode or fax_quiet_mode

    if quiet_mode:
        log.set_level('warn')

    utils.log_title(__title__, __version__)   
   
    if os.getuid() == 0:
        log.warn("hp-makeuri should not be run as root.")

    if len(args) != 1:
        log.error("You must specify one SERIAL NO., IP, USB ID or DEVNODE on the command line.")
        usage()

    param = args[0]

    if 'localhost' in param.lower():
        log.error("Invalid hostname")
        usage()

    cups_uri, sane_uri, fax_uri = device.makeURI(param, jd_port)

    if not cups_uri:
        log.error("Device not found")
        sys.exit(1)

    if cups_quiet_mode:
        print cups_uri

    elif not quiet_mode:    
        log.info("CUPS URI: %s" % cups_uri)

    if sane_uri:
        if sane_quiet_mode:
            print sane_uri
        
        elif not quiet_mode:
            log.info("SANE URI: %s" % sane_uri)
    
    elif not sane_uri and sane_quiet_mode:
        log.error("Device does not support scan.")

    if fax_uri:
        if fax_quiet_mode:
            print fax_uri
        
        elif not quiet_mode:
            log.info("HP Fax URI: %s" % fax_uri)
            
    elif not fax_uri and fax_quiet_mode:
        log.error("Device does not support fax.")

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

if not quiet_mode:
    log.info("")
    log.info("Done.")