2
# -*- coding: utf-8 -*-
4
# (c) Copyright 2003-2009 Hewlett-Packard Development Company, L.P.
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.
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.
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
24
__title__ = 'CUPS Fax Backend (hpfax:)'
25
__doc__ = "CUPS backend for PC send fax. Generally this backend is run by CUPS, not directly by a user. To send a fax as a user, run hp-sendfax or print to the device's CUPS fax queue."
38
CUPS_BACKEND_OK = 0 # Job completed successfully
39
CUPS_BACKEND_FAILED = 1 # Job failed, use error-policy
40
CUPS_BACKEND_AUTH_REQUIRED = 2 # Job failed, authentication required
41
CUPS_BACKEND_HOLD = 3 # Job failed, hold job
42
CUPS_BACKEND_STOP = 4 # Job failed, stop queue
43
CUPS_BACKEND_CANCEL = 5 # Job failed, cancel job
49
config_file = '/etc/hp/hplip.conf'
54
syslog.syslog("hpfax[%d]: error: %s\n" % (pid, msg))
55
log.stderr("ERROR: %s\n" % msg)
58
if os.path.exists(config_file):
59
config = ConfigParser.ConfigParser()
60
config.read(config_file)
63
home_dir = config.get('dirs', 'home')
65
bug("Error setting home directory: home= under [dirs] not found.")
68
bug("Error setting home directory: /etc/hp/hplip.conf not found")
71
if not home_dir or not os.path.exists(home_dir):
72
bug("Error setting home directory: Home directory %s not found." % home_dir)
75
sys.path.insert(0, home_dir)
81
from base.codes import *
82
from base import device
83
from base import utils
85
except ImportError, e:
86
bug("Error importing HPLIP modules: %s\n" % (pid, e))
90
syslog.syslog("SIGPIPE!")
93
USAGE = [(__doc__, "", "para", True),
94
("Usage: hpfax [job_id] [username] [title] [copies] [options]", "", "summary", True),
96
utils.USAGE_LOGGING1, utils.USAGE_LOGGING2, utils.USAGE_LOGGING3,
100
def usage(typ='text'):
102
utils.log_title(__title__, __version__)
104
utils.format_text(USAGE, typ, title=__title__, crumb='hpfax:')
105
sys.exit(CUPS_BACKEND_OK)
107
# Send dbus event to hpssd on dbus system bus
108
def send_message(device_uri, printer_name, event_code, username, job_id, title, pipe_name=''):
109
args = [device_uri, printer_name, event_code, username, job_id, title, pipe_name]
110
msg = lowlevel.SignalMessage('/', 'com.hplip.StatusService', 'Event')
111
msg.append(signature='ssisiss', *args)
113
SystemBus().send_message(msg)
117
opts, args = getopt.getopt(sys.argv[1:], 'l:hg', ['level=', 'help', 'help-rest', 'help-man'])
119
except getopt.GetoptError:
124
if o in ('-l', '--logging'):
125
log_level = a.lower().strip()
126
log.set_level(log_level)
129
log.set_level('debug')
131
elif o in ('-h', '--help'):
134
elif o == '--help-rest':
137
elif o == '--help-man':
142
cups11 = utils.to_bool(sys_conf.get('configure', 'cups11', '0'))
145
probed_devices = device.probeDevices(['usb', 'par'], filter={'fax-type': (operator.gt, 0)})
147
sys.exit(CUPS_BACKEND_FAILED)
150
for uri in probed_devices:
152
back_end, is_hp, bus, model, serial, dev_file, host, zc, port = \
153
device.parseDeviceURI(uri)
157
mq = device.queryModelByModel(model)
159
if mq.get('fax-type', FAX_TYPE_NONE) in (FAX_TYPE_MARVELL,):
162
print 'direct %s "HP Fax 3" "%s USB %s HP Fax HPLIP" "MFG:HP;MDL:Fax 3;DES:HP Fax 3;"' % \
163
(uri.replace("hp:", "hpfax:"), model.replace('_', ' '), serial)
166
print 'direct %s "HP Fax 3" "%s LPT HP Fax HPLIP" "MFG:HP;MDL:Fax 3;DES:HP Fax 3;"' % \
167
(uri.replace("hp:", "hpfax:"), model.replace('_', ' '))
169
elif mq.get('fax-type', FAX_TYPE_NONE) in (FAX_TYPE_SOAP,) or mq.get('fax-type', FAX_TYPE_NONE) in (FAX_TYPE_LEDMSOAP,):
172
print 'direct %s "HP Fax 2" "%s USB %s HP Fax HPLIP" "MFG:HP;MDL:Fax 2;DES:HP Fax 2;"' % \
173
(uri.replace("hp:", "hpfax:"), model.replace('_', ' '), serial)
176
print 'direct %s "HP Fax 2" "%s LPT HP Fax HPLIP" "MFG:HP;MDL:Fax 2;DES:HP Fax 2;"' % \
177
(uri.replace("hp:", "hpfax:"), model.replace('_', ' '))
178
elif mq.get('fax-type', FAX_TYPE_NONE) in (FAX_TYPE_LEDM,):
181
print 'direct %s "HP Fax 4" "%s USB %s HP Fax HPLIP" "MFG:HP;MDL:Fax 4;DES:HP Fax 4;"' % \
182
(uri.replace("hp:", "hpfax:"), model.replace('_', ' '), serial)
185
print 'direct %s "HP Fax 4" "%s LPT HP Fax HPLIP" "MFG:HP;MDL:Fax 4;DES:HP Fax 4;"' % \
186
(uri.replace("hp:", "hpfax:"), model.replace('_', ' '))
191
print 'direct %s "HP Fax" "%s USB %s HP Fax HPLIP" "MFG:HP;MDL:Fax;DES:HP Fax;"' % \
192
(uri.replace("hp:", "hpfax:"), model.replace('_', ' '), serial)
195
print 'direct %s "HP Fax" "%s LPT HP Fax HPLIP" "MFG:HP;MDL:Fax;DES:HP Fax;"' % \
196
(uri.replace("hp:", "hpfax:"), model.replace('_', ' '))
200
if good_devices == 0:
202
print 'direct hpfax:/no_device_found "HP Fax" "no_device_found" ""'
204
print 'direct hpfax "Unknown" "HP Fax (HPLIP)" ""'
206
sys.exit(CUPS_BACKEND_OK)
212
from dbus import SystemBus, lowlevel
214
bug("HPLIP pc send fax requires dbus and python-dbus")
215
sys.exit(CUPS_BACKEND_FAILED)
218
# Ignore: .../dbus/connection.py:242: DeprecationWarning: object.__init__() takes no parameters
219
# (occurring on Python 2.6/dBus 0.83/Ubuntu 9.04)
220
warnings.simplefilter("ignore", DeprecationWarning)
222
# CUPS provided environment
224
device_uri = os.environ['DEVICE_URI']
225
printer_name = os.environ['PRINTER']
227
bug("Improper environment: Must be run by CUPS.")
228
sys.exit(CUPS_BACKEND_FAILED)
233
job_id, username, title, copies, options = args[0:5]
236
bug("Invalid command line: invalid arguments.")
237
sys.exit(CUPS_BACKEND_FAILED)
239
send_message(device_uri, printer_name, EVENT_START_FAX_PRINT_JOB, username, job_id, title)
242
input_fd = file(args[5], 'r')
247
tmp_dir = '/var/log/hp/tmp'
250
pipe_name = os.path.join(tmp_dir, "hpfax-pipe-%d" % job_id)
252
# Create the named pipe. Make sure it exists before sending
261
# Send dbus event to hpssd
262
send_message(device_uri, printer_name, EVENT_FAX_RENDER_COMPLETE, username, job_id, title, pipe_name)
265
pipe = os.open(pipe_name, os.O_WRONLY)
269
data = os.read(input_fd, PIPE_BUF)
275
#syslog.syslog("Writing %d to pipe..." % len(data))
276
bytes_read += len(data)
279
bug("No data on input file descriptor.")
280
sys.exit(CUPS_BACKEND_FAILED)
286
send_message(device_uri, printer_name, EVENT_END_FAX_PRINT_JOB, username, job_id, title)
288
sys.exit(CUPS_BACKEND_OK)