-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
monitor.py
704 lines (595 loc) · 26 KB
/
monitor.py
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
#!/usr/bin/env python
# -*- coding: utf-8 -*-
## Copyright (C) 2007, 2008 Tim Waugh <twaugh@redhat.com>
## Copyright (C) 2007, 2008 Red Hat, Inc.
## 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., 675 Mass Ave, Cambridge, MA 02139, USA.
import cups
import dbus
import time
from debug import *
import pprint
from PyQt4.QtCore import *
#global _
#_ = lambda x: x
#def set_gettext_function (x):
# _ = x
import statereason
from statereason import StateReason
#statereason.set_gettext_function (_)
CONNECTING_TIMEOUT = 60 # seconds
MIN_REFRESH_INTERVAL = 1 # seconds
def state_reason_is_harmless (reason):
if (reason.startswith ("moving-to-paused") or
reason.startswith ("paused") or
reason.startswith ("shutdown") or
reason.startswith ("stopping") or
reason.startswith ("stopped-partly")):
return True
return False
def collect_printer_state_reasons (connection):
result = {}
try:
printers = connection.getPrinters ()
except cups.IPPError:
return result
for name, printer in printers.iteritems ():
reasons = printer["printer-state-reasons"]
for reason in reasons:
if reason == "none":
break
if state_reason_is_harmless (reason):
continue
if not result.has_key (name):
result[name] = []
result[name].append (StateReason (name, reason))
return result
class Watcher:
# Interface definition
def monitor_exited (self, monitor):
debugprint (repr (monitor) + " exited")
def state_reason_added (self, monitor, reason):
debugprint (repr (monitor) + ": +" + repr (reason))
def state_reason_removed (self, monitor, reason):
debugprint (repr (monitor) + ": -" + repr (reason))
def still_connecting (self, monitor, reason):
debugprint (repr (monitor) + ": `%s' still connecting" %
reason.get_printer ())
def now_connected (self, monitor, printer):
debugprint (repr (monitor) + ": `%s' now connected" % printer)
def current_printers_and_jobs (self, monitor, printers, jobs):
debugprint (repr (monitor) + ": printers and jobs lists provided")
def job_added (self, monitor, jobid, eventname, event, jobdata):
debugprint (repr (monitor) + ": job %d added" % jobid)
def job_event (self, monitor, jobid, eventname, event, jobdata):
debugprint (repr (monitor) + ": job %d has event `%s'" %
(jobid, eventname))
def job_removed (self, monitor, jobid, eventname, event):
debugprint (repr (monitor) + ": job %d removed" % jobid)
def printer_added (self, monitor, printer):
debugprint (repr (monitor) + ": printer `%s' added" % printer)
def printer_event (self, monitor, printer, eventname, event):
debugprint (repr (monitor) + ": printer `%s' has event `%s'" %
(printer, eventname))
def printer_removed (self, monitor, printer):
debugprint (repr (monitor) + ": printer `%s' removed" % printer)
def cups_connection_error (self, monitor):
debugprint (repr (monitor) + ": CUPS connection error")
def cups_ipp_error (self, monitor, e, m):
debugprint (repr (monitor) + ": CUPS IPP error (%d, %s)" %
(e, repr (m)))
class Monitor:
# Monitor jobs and printers.
DBUS_PATH="/com/redhat/PrinterSpooler"
DBUS_IFACE="com.redhat.PrinterSpooler"
def __init__(self, watcher, bus=None, my_jobs=True, specific_dests=None,
monitor_jobs=True, host=None, port=None, encryption=None):
self.watcher = watcher
self.my_jobs = my_jobs
self.specific_dests = specific_dests
self.monitor_jobs = monitor_jobs
self.jobs = {}
self.printer_state_reasons = {}
self.printers = set()
self.process_pending_events = True
self.fetch_jobs_timer = None
if host:
cups.setServer (host)
if port:
cups.setPort (port)
if encryption:
cups.setEncryption (encryption)
self.user = cups.getUser ()
self.host = cups.getServer ()
self.port = cups.getPort ()
self.encryption = cups.getEncryption ()
self.which_jobs = "not-completed"
self.reasons_seen = {}
self.connecting_timers = {}
self.still_connecting = set()
self.connecting_to_device = {}
self.received_any_dbus_signals = False
self.update_timer = None
if bus == None:
try:
bus = dbus.SystemBus ()
except dbus.exceptions.DBusException:
# System bus not running.
pass
if bus != None:
bus.add_signal_receiver (self.handle_dbus_signal,
path=self.DBUS_PATH,
dbus_interface=self.DBUS_IFACE)
self.bus = bus
self.sub_id = -1
self.refresh ()
def get_jobs (self):
return self.jobs.copy ()
def cleanup (self):
if self.sub_id != -1:
user = cups.getUser ()
try:
cups.setUser (self.user)
c = cups.Connection (host=self.host,
port=self.port,
encryption=self.encryption)
c.cancelSubscription (self.sub_id)
debugprint ("Canceled subscription %d" % self.sub_id)
except:
pass
cups.setUser (user)
if self.bus != None:
self.bus.remove_signal_receiver (self.handle_dbus_signal,
path=self.DBUS_PATH,
dbus_interface=self.DBUS_IFACE)
self.watcher.monitor_exited (self)
def set_process_pending (self, whether):
self.process_pending_events = whether
def check_still_connecting(self):
"""Timer callback to check on connecting-to-device reasons."""
#del self.connecting_timers[printer]
#debugprint ("Still-connecting timer fired for `%s'" % printer)
(printer_jobs, my_printers) = self.sort_jobs_by_printer ()
self.update_connecting_devices (printer_jobs)
# Don't run this callback again.
return False
def update_connecting_devices(self, printer_jobs={}):
"""Updates connecting_to_device dict and still_connecting set."""
time_now = time.time ()
connecting_to_device = {}
trouble = False
for printer, reasons in self.printer_state_reasons.iteritems ():
connected = True
for reason in reasons:
if reason.get_reason () == "connecting-to-device":
have_processing_job = False
for job, data in \
printer_jobs.get (printer, {}).iteritems ():
state = data.get ('job-state',
cups.IPP_JOB_CANCELED)
if state == cups.IPP_JOB_PROCESSING:
have_processing_job = True
break
if not have_processing_job:
debugprint ("Ignoring stale connecting-to-device x")
continue
# Build a new connecting_to_device dict. If our existing
# dict already has an entry for this printer, use that.
printer = reason.get_printer ()
t = self.connecting_to_device.get (printer, time_now)
connecting_to_device[printer] = t
debugprint ("Connecting time: %d" % (time_now - t))
if time_now - t >= CONNECTING_TIMEOUT:
if have_processing_job:
self.still_connecting.add (printer)
self.watcher.still_connecting (self, reason)
connected = False
break
# Clear any previously-notified errors that are now fine.
remove = set()
for printer in self.still_connecting:
if not connecting_to_device.has_key (printer):
remove.add (printer)
self.watcher.now_connected (self, printer)
self.still_connecting = self.still_connecting.difference (remove)
self.connecting_to_device = connecting_to_device
def check_state_reasons(self, my_printers=set(), printer_jobs={}):
# Look for any new reasons since we last checked.
old_reasons_seen_keys = self.reasons_seen.keys ()
reasons_now = set()
for printer, reasons in self.printer_state_reasons.iteritems ():
for reason in reasons:
tuple = reason.get_tuple ()
printer = reason.get_printer ()
reasons_now.add (tuple)
if not self.reasons_seen.has_key (tuple):
# New reason.
self.watcher.state_reason_added (self, reason)
self.reasons_seen[tuple] = reason
if (reason.get_reason () == "connecting-to-device" and
not self.connecting_to_device.has_key (printer)):
# First time we've seen this.
have_processing_job = False
for job, data in \
printer_jobs.get (printer, {}).iteritems ():
state = data.get ('job-state',
cups.IPP_JOB_CANCELED)
if state == cups.IPP_JOB_PROCESSING:
have_processing_job = True
break
if have_processing_job:
QTimer.singleShot((1 + CONNECTING_TIMEOUT) * 1000, self.check_still_connecting)
debugprint ("Start connecting timer for `%s'" %
printer)
else:
# Don't notify about this, as it must be stale.
debugprint ("Ignoring stale connecting-to-device")
if get_debugging ():
debugprint (pprint.pformat (printer_jobs))
self.update_connecting_devices (printer_jobs)
items = self.reasons_seen.keys ()
for tuple in items:
if not tuple in reasons_now:
# Reason no longer present.
reason = self.reasons_seen[tuple]
del self.reasons_seen[tuple]
self.watcher.state_reason_removed (self, reason)
def get_notifications(self):
debugprint ("get_notifications")
user = cups.getUser ()
try:
cups.setUser (self.user)
c = cups.Connection (host=self.host,
port=self.port,
encryption=self.encryption)
try:
try:
notifications = c.getNotifications ([self.sub_id],
[self.sub_seq + 1])
except AttributeError:
notifications = c.getNotifications ([self.sub_id])
except cups.IPPError, (e, m):
cups.setUser (user)
if e == cups.IPP_NOT_FOUND:
# Subscription lease has expired.
self.sub_id = -1
self.refresh ()
return False
self.watcher.cups_ipp_error (self, e, m)
return True
except RuntimeError:
cups.setUser (user)
self.watcher.cups_connection_error (self)
return True
cups.setUser (user)
deferred_calls = []
jobs = self.jobs.copy ()
for event in notifications['events']:
seq = event['notify-sequence-number']
self.sub_seq = seq
nse = event['notify-subscribed-event']
debugprint ("%d %s %s" % (seq, nse, event['notify-text']))
if get_debugging ():
debugprint (pprint.pformat (event))
if nse.startswith ('printer-'):
# Printer events
name = event['printer-name']
if nse == 'printer-added' and name not in self.printers:
self.printers.add (name)
deferred_calls.append ((self.watcher.printer_added,
(self, name)))
elif nse == 'printer-deleted' and name in self.printers:
self.printers.remove (name)
items = self.reasons_seen.keys ()
for tuple in items:
if tuple[1] == name:
reason = self.reasons_seen[tuple]
del self.reasons_seen[tuple]
deferred_calls.append ((self.watcher.state_reason_removed,
(self, reason)))
if self.printer_state_reasons.has_key (name):
del self.printer_state_reasons[name]
deferred_calls.append ((self.watcher.printer_removed,
(self, name)))
elif name in self.printers:
printer_state_reasons = event['printer-state-reasons']
reasons = []
for reason in printer_state_reasons:
if reason == "none":
break
if state_reason_is_harmless (reason):
continue
reasons.append (StateReason (name, reason))
self.printer_state_reasons[name] = reasons
deferred_calls.append ((self.watcher.printer_event,
(self, name, nse, event)))
continue
# Job events
if not nse.startswith ("job-"):
# Some versions of CUPS give empty
# notify-subscribed-event attributes (STR #3608).
debugprint ("Unhandled nse %s" % repr (nse))
continue
jobid = event['notify-job-id'] #BREAKAGE!
if (nse == 'job-created' or
(nse == 'job-state-changed' and
not jobs.has_key (jobid) and
event['job-state'] == cups.IPP_JOB_PROCESSING)):
if (self.specific_dests != None and
event['printer-name'] not in self.specific_dests):
continue
try:
attrs = c.getJobAttributes (jobid)
if (self.my_jobs and
attrs['job-originating-user-name'] != cups.getUser ()):
continue
jobs[jobid] = attrs
except AttributeError:
jobs[jobid] = {'job-k-octets': 0}
except cups.IPPError, (e, m):
self.watcher.cups_ipp_error (self, e, m)
jobs[jobid] = {'job-k-octets': 0}
except KeyError:
jobs[jobid] = {'job-k-octets': 0}
deferred_calls.append ((self.watcher.job_added,
(self, jobid, nse, event,
jobs[jobid].copy ())))
elif (nse == 'job-completed' or
(nse == 'job-state-changed' and
event['job-state'] == cups.IPP_JOB_COMPLETED)):
if not (self.which_jobs in ['completed', 'all']):
try:
del jobs[jobid]
deferred_calls.append ((self.watcher.job_removed,
(self, jobid, nse, event)))
except KeyError:
pass
continue
try:
job = jobs[jobid]
except KeyError:
continue
for attribute in ['job-state',
'job-name']:
job[attribute] = event[attribute]
if event.has_key ('notify-printer-uri'):
job['job-printer-uri'] = event['notify-printer-uri']
deferred_calls.append ((self.watcher.job_event,
(self, jobid, nse, event, job.copy ())))
self.set_process_pending (False)
self.update_jobs (jobs)
self.jobs = jobs
for (fn, args) in deferred_calls:
fn (*args)
self.set_process_pending (True)
# Update again when we're told to. If we're getting CUPS
# D-Bus signals, however, rely on those instead.
if not self.received_any_dbus_signals:
interval = 1000 * notifications['notify-get-interval']
QTimer.singleShot(interval, self.get_notifications)
return False
def refresh(self, which_jobs=None, refresh_all=True):
debugprint ("refresh")
if which_jobs != None:
self.which_jobs = which_jobs
user = cups.getUser ()
try:
cups.setUser (self.user)
c = cups.Connection (host=self.host,
port=self.port,
encryption=self.encryption)
except RuntimeError:
self.watcher.cups_connection_error (self)
cups.setUser (user)
return
if self.sub_id != -1:
try:
c.cancelSubscription (self.sub_id)
except cups.IPPError, (e, m):
self.watcher.cups_ipp_error (self, e, m)
debugprint ("Canceled subscription %d" % self.sub_id)
try:
del self.sub_seq
except AttributeError:
pass
events = ["printer-added",
"printer-deleted",
"printer-state-changed"]
if self.monitor_jobs:
events.extend (["job-created",
"job-completed",
"job-stopped",
"job-progress",
"job-state-changed"])
try:
self.sub_id = c.createSubscription ("/", events=events)
except cups.IPPError, (e, m):
self.watcher.cups_ipp_error (self, e, m)
cups.setUser (user)
QTimer.singleShot(MIN_REFRESH_INTERVAL * 1000, self.get_notifications)
debugprint ("Created subscription %d" % self.sub_id)
# Doesn't work, and I don't know how to fix at the moment
#if self.monitor_jobs:
#jobs = self.jobs.copy ()
#if self.which_jobs not in ['all', 'completed']:
## Filter out completed jobs.
#filtered = {}
#for jobid, job in jobs.iteritems ():
#if job['job-state'] < cups.IPP_JOB_CANCELED:
#filtered[jobid] = job
#jobs = filtered
#self.fetch_first_job_id = 1
#QTimer.singleShot(MIN_REFRESH_INTERVAL * 1000, self.fetch_jobs)
#else:
#jobs = {}
try:
if self.monitor_jobs:
jobs = c.getJobs (which_jobs=self.which_jobs,
my_jobs=self.my_jobs)
else:
jobs = {}
self.printer_state_reasons = collect_printer_state_reasons (c)
dests = c.getPrinters ()
self.printers = set(dests.keys ())
except cups.IPPError, (e, m):
self.watcher.cups_ipp_error (self, e, m)
return
except RuntimeError:
self.watcher.cups_connection_error (self)
return
if self.specific_dests != None:
for jobid in jobs.keys ():
uri = jobs[jobid].get('job-printer-uri', '/')
i = uri.rfind ('/')
printer = uri[i + 1:]
if printer not in self.specific_dests:
del jobs[jobid]
self.set_process_pending (False)
self.watcher.current_printers_and_jobs (self, self.printers.copy (),
jobs.copy ())
self.update_jobs (jobs)
self.jobs = jobs
self.set_process_pending (True)
return False
self.jobs = jobs
return False
def sort_jobs_by_printer (self, jobs=None):
if jobs == None:
jobs = self.jobs
my_printers = set()
printer_jobs = {}
for job, data in jobs.iteritems ():
state = data.get ('job-state', cups.IPP_JOB_CANCELED)
if state >= cups.IPP_JOB_CANCELED:
continue
uri = data.get ('job-printer-uri', '')
i = uri.rfind ('/')
if i == -1:
continue
printer = uri[i + 1:]
my_printers.add (printer)
if not printer_jobs.has_key (printer):
printer_jobs[printer] = {}
printer_jobs[printer][job] = data
return (printer_jobs, my_printers)
def fetch_jobs (self, refresh_all):
if not self.process_pending_events:
# Skip this call. We'll get called again soon.
return True
user = cups.getUser ()
try:
cups.setUser (self.user)
c = cups.Connection (host=self.host,
port=self.port,
encryption=self.encryption)
except RuntimeError:
self.watcher.cups_connection_error (self)
self.fetch_jobs_timer = None
cups.setUser (user)
return False
limit = 1
try:
fetched = c.getJobs (which_jobs=self.which_jobs,
my_jobs=self.my_jobs,
first_job_id=self.fetch_first_job_id,
limit=limit)
except cups.IPPError, (e, m):
self.watcher.cups_ipp_error (self, e, m)
self.fetch_jobs_timer = None
cups.setUser (user)
return False
cups.setUser (user)
got = len (fetched)
debugprint ("Got %s jobs, asked for %s" % (got, limit))
deferred_calls = []
jobs = self.jobs.copy ()
jobids = fetched.keys ()
jobids.sort ()
if got > 0:
last_jobid = jobids[got - 1]
else:
last_jobid = self.fetch_first_job_id + limit
for jobid in xrange (self.fetch_first_job_id, last_jobid + 1):
try:
job = fetched[jobid]
if self.specific_dests != None:
uri = job.get('job-printer-uri', '/')
i = uri.rfind ('/')
printer = uri[i + 1:]
if printer not in self.specific_dests:
raise KeyError
if jobs.has_key (jobid):
fn = self.watcher.job_event
else:
fn = self.watcher.job_added
jobs[jobid] = job
deferred_calls.append ((fn,
(self, jobid, '', {}, job.copy ())))
except KeyError:
# No job by that ID.
if jobs.has_key (jobid):
del jobs[jobid]
deferred_calls.append ((self.watcher.job_removed,
(self, jobid, '', {})))
jobids = jobs.keys ()
jobids.sort ()
if got < limit:
trim = False
for i in range (len (jobids)):
jobid = jobids[i]
if not trim and jobid > last_jobid:
trim = True
if trim:
del jobs[jobid]
deferred_calls.append ((self.watcher.job_removed,
(self, jobid, '', {})))
self.update_jobs (jobs)
self.jobs = jobs
for (fn, args) in deferred_calls:
fn (*args)
if got < limit:
# That's all. Don't run this timer again.
self.fetch_jobs_timer = None
return False
# Remember where we got up to and run this timer again.
next = jobid + 1
while not refresh_all and self.jobs.has_key (next):
next += 1
self.fetch_first_job_id = next
return True
def sort_jobs_by_printer (self, jobs=None):
if jobs == None:
jobs = self.jobs
my_printers = set()
printer_jobs = {}
for job, data in jobs.iteritems ():
state = data.get ('job-state', cups.IPP_JOB_CANCELED)
if state >= cups.IPP_JOB_CANCELED:
continue
uri = data.get ('job-printer-uri', '')
i = uri.rfind ('/')
if i == -1:
continue
printer = uri[i + 1:]
my_printers.add (printer)
if not printer_jobs.has_key (printer):
printer_jobs[printer] = {}
printer_jobs[printer][job] = data
return (printer_jobs, my_printers)
def update_jobs(self, jobs):
debugprint ("update_jobs")
(printer_jobs, my_printers) = self.sort_jobs_by_printer (jobs)
self.check_state_reasons (my_printers, printer_jobs)
def handle_dbus_signal(self, *args):
QTimer.singleShot(200, self.get_notifications)
if not self.received_any_dbus_signals:
self.received_any_dbus_signals = True