root / pykota / trunk / pykota / accounter.py @ 1785

Revision 1713, 5.8 kB (checked in by jalet, 20 years ago)

Added fix for incorrect job's size when hardware accounting fails

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1# PyKota
2# -*- coding: ISO-8859-15 -*-
3#
4# PyKota : Print Quotas for CUPS and LPRng
5#
6# (c) 2003-2004 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
20#
21# $Id$
22#
23# $Log$
24# Revision 1.20  2004/09/13 16:02:45  jalet
25# Added fix for incorrect job's size when hardware accounting fails
26#
27# Revision 1.19  2004/08/31 23:29:53  jalet
28# Introduction of the new 'onaccountererror' configuration directive.
29# Small fix for software accounter's return code which can't be None anymore.
30# Make software and hardware accounting code look similar : will be factorized
31# later.
32#
33# Revision 1.18  2004/07/22 22:41:48  jalet
34# Hardware accounting for LPRng should be OK now. UNTESTED.
35#
36# Revision 1.17  2004/07/16 12:22:47  jalet
37# LPRng support early version
38#
39# Revision 1.16  2004/05/25 09:15:15  jalet
40# accounter.py : old code deleted
41# the rest : now exports PYKOTAPRECOMPUTEDJOBSIZE and PYKOTAPRECOMPUTEDJOBPRICE
42#
43# Revision 1.15  2004/05/24 22:45:49  jalet
44# New 'enforcement' directive added
45# Polling loop improvements
46#
47# Revision 1.14  2004/05/18 14:49:19  jalet
48# Big code changes to completely remove the need for "requester" directives,
49# jsut use "hardware(... your previous requester directive's content ...)"
50#
51# Revision 1.13  2004/01/12 22:43:40  jalet
52# New formula to compute a job's price
53#
54# Revision 1.12  2004/01/11 23:43:31  jalet
55# Bug wrt number of copies with CUPS should be fixed.
56#
57# Revision 1.11  2004/01/11 23:22:42  jalet
58# Major code refactoring, it's way cleaner, and now allows automated addition
59# of printers on first print.
60#
61# Revision 1.10  2004/01/08 14:10:32  jalet
62# Copyright year changed.
63#
64# Revision 1.9  2003/12/27 16:49:25  uid67467
65# Should be ok now.
66#
67# Revision 1.7  2003/11/25 23:46:40  jalet
68# Don't try to verify if module name is valid, Python does this better than us.
69#
70# Revision 1.6  2003/11/12 23:28:55  jalet
71# More work on new backend. This commit may be unstable.
72#
73# Revision 1.5  2003/10/07 09:07:28  jalet
74# Character encoding added to please latest version of Python
75#
76# Revision 1.4  2003/07/14 14:14:59  jalet
77# Old template
78#
79# Revision 1.3  2003/04/30 19:53:58  jalet
80# 1.05
81#
82# Revision 1.2  2003/04/30 13:36:40  jalet
83# Stupid accounting method was added.
84#
85# Revision 1.1  2003/04/29 18:37:54  jalet
86# Pluggable accounting methods (actually doesn't support external scripts)
87#
88#
89#
90
91import sys
92
93class PyKotaAccounterError(Exception):
94    """An exception for Accounter related stuff."""
95    def __init__(self, message = ""):
96        self.message = message
97        Exception.__init__(self, message)
98    def __repr__(self):
99        return self.message
100    __str__ = __repr__
101   
102class AccounterBase :   
103    """A class to account print usage by querying printers."""
104    def __init__(self, kotafilter, arguments) :
105        """Sets instance vars depending on the current printer."""
106        self.filter = kotafilter
107        self.arguments = arguments
108        self.onerror = self.filter.config.getPrinterOnAccounterError(self.filter.printername)
109        self.isSoftware = 1 # by default software accounting
110       
111    def getLastPageCounter(self) :   
112        """Returns last internal page counter value (possibly faked)."""
113        try :
114            return self.LastPageCounter or 0
115        except :   
116            return 0
117           
118    def beginJob(self, printer) :   
119        """Saves the computed job size."""
120        # computes job's size
121        self.JobSize = self.computeJobSize()
122        if ((self.filter.printingsystem == "CUPS") \
123            and (self.filter.preserveinputfile is not None)) \
124            or (self.filter.printingsystem != "CUPS") :
125                self.JobSize *= self.filter.copies
126       
127        # get last job information for this printer
128        if not printer.LastJob.Exists :
129            # The printer hasn't been used yet, from PyKota's point of view
130            self.LastPageCounter = 0
131        else :   
132            # get last job size and page counter from Quota Storage
133            # Last lifetime page counter before actual job is
134            # last page counter + last job size
135            self.LastPageCounter = int(printer.LastJob.PrinterPageCounter or 0) + int(printer.LastJob.JobSize or 0)
136       
137    def fakeBeginJob(self) :   
138        """Do nothing."""
139        pass
140       
141    def endJob(self, printer) :   
142        """Do nothing."""
143        pass
144       
145    def getJobSize(self, printer) :   
146        """Returns the actual job size."""
147        try :
148            return self.JobSize
149        except AttributeError :   
150            return 0
151       
152    def computeJobSize(self) :   
153        """Must be overriden in children classes."""
154        raise RuntimeError, "AccounterBase.computeJobSize() must be overriden !"
155       
156def openAccounter(kotafilter) :
157    """Returns a connection handle to the appropriate accounter."""
158    (backend, args) = kotafilter.config.getAccounterBackend(kotafilter.printername)
159    try :
160        exec "from pykota.accounters import %s as accounterbackend" % backend.lower()
161    except ImportError :
162        raise PyKotaAccounterError, _("Unsupported accounter backend %s") % backend
163    else :   
164        return accounterbackend.Accounter(kotafilter, args)
Note: See TracBrowser for help on using the browser.