root / pykota / trunk / pykota / accounters / pjl.py @ 3194

Revision 3194, 14.5 kB (checked in by jerome, 17 years ago)

Upgraded dependencies' version numbers.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Auth Date Rev Id
Line 
1# PyKota
2# -*- coding: ISO-8859-15 -*-
3#
4# PyKota - Print Quotas for CUPS and LPRng
5#
6# (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet <alet@librelogiciel.com>
7# This program is free software; you can redistribute it and/or modify
8# it under the terms of the GNU General Public License as published by
9# the Free Software Foundation; either version 2 of the License, or
10# (at your option) any later version.
11#
12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
18# along with this program; if not, write to the Free Software
19# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20#
21# $Id$
22#
23#
24
25import sys
26import os
27import socket
28import errno
29import time
30import threading
31import Queue
32
33from pykota import constants
34
35FORMFEEDCHAR = chr(0x0c)     # Form Feed character, ends PJL answers.
36
37# Old method : pjlMessage = "\033%-12345X@PJL USTATUSOFF\r\n@PJL INFO STATUS\r\n@PJL INFO PAGECOUNT\r\n\033%-12345X"
38# Here's a new method, which seems to work fine on my HP2300N, while the
39# previous one didn't.
40# TODO : We could also experiment with USTATUS JOB=ON and we would know for sure
41# when the job is finished, without having to poll the printer repeatedly.
42pjlMessage = "\033%-12345X@PJL USTATUS DEVICE=ON\r\n@PJL INFO STATUS\r\n@PJL INFO PAGECOUNT\r\n@PJL USTATUS DEVICE=OFF\033%-12345X"
43pjlStatusValues = {
44                    "10000" : "Powersave Mode",
45                    "10001" : "Ready Online",
46                    "10002" : "Ready Offline",
47                    "10003" : "Warming Up",
48                    "10004" : "Self Test",
49                    "10005" : "Reset",
50                    "10023" : "Printing",
51                    "35078" : "Powersave Mode",         # 10000 is ALSO powersave !!!
52                    "40000" : "Sleep Mode",             # Standby
53                  }
54                 
55class Handler :
56    """A class for PJL print accounting."""
57    def __init__(self, parent, printerhostname, skipinitialwait=False) :
58        self.parent = parent
59        self.printerHostname = printerhostname
60        self.skipinitialwait = skipinitialwait
61        try :
62            self.port = int(self.parent.arguments.split(":")[1].strip())
63        except (IndexError, ValueError) :
64            self.port = 9100
65        self.printerInternalPageCounter = self.printerStatus = None
66        self.closed = False
67        self.sock = None
68        self.queue = None
69        self.readthread = None
70        self.quitEvent = threading.Event()
71       
72    def __del__(self) :   
73        """Ensures the network connection is closed at object deletion time."""
74        self.close()
75       
76    def open(self) :   
77        """Opens the network connection."""
78        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
79        try :
80            sock.settimeout(2.0)
81            sock.connect((self.printerHostname, self.port))
82        except socket.error, msg :
83            self.parent.filter.printInfo(_("Problem during connection to %s:%s : %s") % (self.printerHostname, self.port, str(msg)), "warn")
84            return False
85        else :
86            self.sock = sock
87            self.closed = False
88            self.quitEvent.clear()
89            self.queue = Queue.Queue(0)
90            self.readthread = threading.Thread(target=self.readloop)
91            self.readthread.start()
92            time.sleep(1)
93            self.parent.filter.logdebug("Connected to printer %s:%s" % (self.printerHostname, self.port))
94            return True
95       
96    def close(self) :   
97        """Closes the network connection."""
98        if not self.closed :
99            self.quitEvent.set()
100            if self.readthread is not None :
101                self.readthread.join()
102                self.readthread = None
103            if self.sock is not None :
104                self.sock.close()
105                self.sock = None
106            self.parent.filter.logdebug("Connection to %s:%s is now closed." % (self.printerHostname, self.port))
107            self.queue = None
108            self.closed = True
109           
110    def readloop(self) :       
111        """Reading loop thread."""
112        self.parent.filter.logdebug("Reading thread started.")
113        buffer = []
114        while not self.quitEvent.isSet() :
115            try :
116                answer = self.sock.recv(1)
117            except socket.timeout :   
118                self.parent.filter.logdebug("Timed out when reading answer from %s:%s" \
119                                                % (self.printerHostname, self.port))
120            except socket.error, (err, msg) :
121                self.parent.filter.printInfo(_("Problem while receiving PJL answer from %s:%s : %s") % (self.printerHostname, self.port, str(msg)), "warn")
122            else :   
123                if answer :
124                    buffer.append(answer)
125                    if answer.endswith(FORMFEEDCHAR) :
126                        self.queue.put("".join(buffer))
127                        buffer = []
128        if buffer :             
129            self.queue.put("".join(buffer))           
130        self.parent.filter.logdebug("Reading thread ended.")
131           
132    def retrievePJLValues(self) :   
133        """Retrieves a printer's internal page counter and status via PJL."""
134        try :
135            nbsent = self.sock.send(pjlMessage)
136            if nbsent != len(pjlMessage) :
137                raise socket.error, "Short write"
138        except socket.error, msg :
139            self.parent.filter.printInfo(_("Problem while sending PJL query to %s:%s : %s") % (self.printerHostname, self.port, str(msg)), "warn")
140        else :   
141            self.parent.filter.logdebug("Query sent to %s : %s" % (self.printerHostname, repr(pjlMessage)))
142            actualpagecount = self.printerStatus = None
143            while (actualpagecount is None) or (self.printerStatus is None) :
144                try :
145                    answer = self.queue.get(True, 5)
146                except Queue.Empty :   
147                    self.parent.filter.logdebug("Timeout when reading printer's answer from %s:%s" % (self.printerHostname, self.port))
148                else :   
149                    readnext = False
150                    self.parent.filter.logdebug("PJL answer : %s" % repr(answer))
151                    for line in [l.strip() for l in answer.split()] : 
152                        if line.startswith("CODE=") :
153                            self.printerStatus = line.split("=")[1]
154                            self.parent.filter.logdebug("Found status : %s" % self.printerStatus)
155                        elif line.startswith("PAGECOUNT=") :   
156                            try :
157                                actualpagecount = int(line.split('=')[1].strip())
158                            except ValueError :   
159                                self.parent.filter.logdebug("Received incorrect datas : [%s]" % line.strip())
160                            else :
161                                self.parent.filter.logdebug("Found pages counter : %s" % actualpagecount)
162                        elif line.startswith("PAGECOUNT") :   
163                            readnext = True # page counter is on next line
164                        elif readnext :   
165                            try :
166                                actualpagecount = int(line.strip())
167                            except ValueError :   
168                                self.parent.filter.logdebug("Received incorrect datas : [%s]" % line.strip())
169                            else :
170                                self.parent.filter.logdebug("Found pages counter : %s" % actualpagecount)
171                                readnext = False
172            self.printerInternalPageCounter = max(actualpagecount, self.printerInternalPageCounter)
173       
174    def waitPrinting(self) :
175        """Waits for printer status being 'printing'."""
176        statusstabilizationdelay = constants.get(self.parent.filter, "StatusStabilizationDelay")
177        noprintingmaxdelay = constants.get(self.parent.filter, "NoPrintingMaxDelay")
178        if not noprintingmaxdelay :
179            self.parent.filter.logdebug("Will wait indefinitely until printer %s is in 'printing' state." % self.parent.filter.PrinterName)
180        else :   
181            self.parent.filter.logdebug("Will wait until printer %s is in 'printing' state or %i seconds have elapsed." % (self.parent.filter.PrinterName, noprintingmaxdelay))
182        previousValue = self.parent.getLastPageCounter()
183        timebefore = time.time()
184        firstvalue = None
185        while True :
186            self.retrievePJLValues()
187            if self.printerStatus in ('10023', '10003') :
188                break
189            if self.printerInternalPageCounter is not None :   
190                if firstvalue is None :
191                    # first time we retrieved a page counter, save it
192                    firstvalue = self.printerInternalPageCounter
193                else :     
194                    # second time (or later)
195                    if firstvalue < self.printerInternalPageCounter :
196                        # Here we have a printer which lies :
197                        # it says it is not printing or warming up
198                        # BUT the page counter increases !!!
199                        # So we can probably quit being sure it is printing.
200                        self.parent.filter.printInfo("Printer %s is lying to us !!!" % self.parent.filter.PrinterName, "warn")
201                        break
202                    elif noprintingmaxdelay and ((time.time() - timebefore) > noprintingmaxdelay) :
203                        # More than X seconds without the printer being in 'printing' mode
204                        # We can safely assume this won't change if printer is now 'idle'
205                        if self.printerStatus in ('10000', '10001', '35078', '40000') :
206                            if self.printerInternalPageCounter == previousValue :
207                                # Here the job won't be printed, because probably
208                                # the printer rejected it for some reason.
209                                self.parent.filter.printInfo("Printer %s probably won't print this job !!!" % self.parent.filter.PrinterName, "warn")
210                            else :     
211                                # Here the job has already been entirely printed, and
212                                # the printer has already passed from 'idle' to 'printing' to 'idle' again.
213                                self.parent.filter.printInfo("Printer %s has probably already printed this job !!!" % self.parent.filter.PrinterName, "warn")
214                            break
215            self.parent.filter.logdebug(_("Waiting for printer %s to be printing...") % self.parent.filter.PrinterName)
216            time.sleep(statusstabilizationdelay)
217       
218    def waitIdle(self) :
219        """Waits for printer status being 'idle'."""
220        statusstabilizationdelay = constants.get(self.parent.filter, "StatusStabilizationDelay")
221        statusstabilizationloops = constants.get(self.parent.filter, "StatusStabilizationLoops")
222        idle_num = 0
223        while True :
224            self.retrievePJLValues()
225            if self.printerStatus in ('10000', '10001', '35078', '40000') :
226                if (self.printerInternalPageCounter is not None) \
227                   and self.skipinitialwait \
228                   and (os.environ.get("PYKOTAPHASE") == "BEFORE") :
229                    self.parent.filter.logdebug("No need to wait for the printer to be idle, it is the case already.")
230                    return 
231                idle_num += 1
232                if idle_num >= statusstabilizationloops :
233                    # printer status is stable, we can exit
234                    break
235            else :   
236                idle_num = 0
237            self.parent.filter.logdebug(_("Waiting for printer %s's idle status to stabilize...") % self.parent.filter.PrinterName)
238            time.sleep(statusstabilizationdelay)
239   
240    def retrieveInternalPageCounter(self) :
241        """Returns the page counter from the printer via internal PJL handling."""
242        while not self.open() :
243            self.parent.filter.logdebug("Will retry in 1 second.")
244            time.sleep(1)
245        try :
246            try :
247                if (os.environ.get("PYKOTASTATUS") != "CANCELLED") and \
248                   (os.environ.get("PYKOTAACTION") == "ALLOW") and \
249                   (os.environ.get("PYKOTAPHASE") == "AFTER") and \
250                   self.parent.filter.JobSizeBytes :
251                    self.waitPrinting()
252                self.waitIdle()   
253            except :   
254                self.parent.filter.printInfo(_("PJL querying stage interrupted. Using latest value seen for internal page counter (%s) on printer %s.") % (self.printerInternalPageCounter, self.parent.filter.PrinterName), "warn")
255                raise
256            else :   
257                return self.printerInternalPageCounter
258        finally :       
259            self.close()
260           
261def main(hostname) :
262    """Tries PJL accounting for a printer host."""
263    class fakeFilter :
264        """Fakes a filter for testing purposes."""
265        def __init__(self) :
266            """Initializes the fake filter."""
267            self.PrinterName = "FakePrintQueue"
268            self.JobSizeBytes = 1
269           
270        def printInfo(self, msg, level="info") :
271            """Prints informational message."""
272            sys.stderr.write("%s : %s\n" % (level.upper(), msg))
273            sys.stderr.flush()
274           
275        def logdebug(self, msg) :   
276            """Prints debug message."""
277            self.printInfo(msg, "debug")
278           
279    class fakeAccounter :       
280        """Fakes an accounter for testing purposes."""
281        def __init__(self) :
282            """Initializes fake accounter."""
283            self.arguments = "pjl:9100"
284            self.filter = fakeFilter()
285            self.protocolHandler = Handler(self, sys.argv[1])
286           
287        def getLastPageCounter(self) :   
288            """Fakes the return of a page counter."""
289            return 0
290       
291    acc = fakeAccounter()           
292    return acc.protocolHandler.retrieveInternalPageCounter()
293   
294if __name__ == "__main__" :           
295    if len(sys.argv) != 2 :   
296        sys.stderr.write("Usage :  python  %s  printer_ip_address\n" % sys.argv[0])
297    else :   
298        def _(msg) :
299            return msg
300           
301        pagecounter = main(sys.argv[1])
302        print "Internal page counter's value is : %s" % pagecounter
303       
Note: See TracBrowser for help on using the browser.