root / pykota / trunk / bin / pkprinters @ 2739

Revision 2725, 14.6 kB (checked in by jerome, 19 years ago)

Doesn't list anymore entries which don't exist.

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
Line 
1#! /usr/bin/env python
2# -*- coding: ISO-8859-15 -*-
3
4# PyKota Printers Manager
5#
6# PyKota - Print Quotas for CUPS and LPRng
7#
8# (c) 2003, 2004, 2005, 2006 Jerome Alet <alet@librelogiciel.com>
9# This program is free software; you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation; either version 2 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program; if not, write to the Free Software
21# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22#
23# $Id$
24#
25#
26
27import os
28import sys
29import pwd
30
31from pykota.tool import PyKotaTool, PyKotaToolError, PyKotaCommandLineError, crashed, N_
32
33__doc__ = N_("""pkprinters v%(__version__)s (c) %(__years__)s %(__author__)s
34
35A Printers Manager for PyKota.
36
37command line usage :
38
39  pkprinters [options] printer1 printer2 printer3 ... printerN
40
41options :
42
43  -v | --version       Prints pkprinters's version number then exits.
44  -h | --help          Prints this message then exits.
45 
46  -a | --add           Adds printers if they don't exist on the Quota
47                       Storage Server. If they exist, they are modified
48                       unless -s|--skipexisting is also used.
49                       
50  -d | --delete        Deletes printers from the quota storage.
51 
52  -D | --description d Adds a textual description to printers.
53                       
54  -c | --charge p[,j]  Sets the price per page and per job to charge.
55                       Job price is optional.
56                       If both are to be set, separate them with a comma.
57                       Floating point and negative values are allowed.
58 
59  -g | --groups pg1[,pg2...] Adds or Remove the printer(s) to the printer
60                       groups pg1, pg2, etc... which must already exist.
61                       A printer group is just like a normal printer,
62                       only that it is usually unknown from the printing
63                       system. Create printer groups exactly the same
64                       way that you create printers, then add other
65                       printers to them with this option.
66                       Accounting is done on a printer and on all
67                       the printer groups it belongs to, quota checking
68                       is done on a printer and on all the printer groups
69                       it belongs to.
70                       If the --remove option below is not used, the
71                       default action is to add printers to the specified
72                       printer groups.
73                       
74  -l | --list          List informations about the printer(s) and the
75                       printers groups it is a member of.
76                       
77  -r | --remove        In combination with the --groups option above,                       
78                       remove printers from the specified printers groups.
79                       
80  -s | --skipexisting  In combination with the --add option above, tells
81                       pkprinters to not modify existing printers.
82                       
83  -m | --maxjobsize s  Sets the maximum job size allowed on the printer
84                       to s pages.
85                       
86  -p | --passthrough   Activate passthrough mode for the printer. In this
87                       mode, users are allowed to print without any impact
88                       on their quota or account balance.
89                       
90  -n | --nopassthrough Deactivate passthrough mode for the printer.
91                       Without -p or -n, printers are created in
92                       normal mode, i.e. no passthrough.
93 
94  printer1 through printerN can contain wildcards if the --add option
95  is not set.
96 
97examples :                             
98
99  $ pkprinters --add -D "HP Printer" --charge 0.05,0.1 hp2100 hp2200 hp8000
100 
101  Will create three printers named hp2100, hp2200 and hp8000.
102  Their price per page will be set at 0.05 unit, and their price
103  per job will be set at 0.1 unit. Units are in your own currency,
104  or whatever you want them to mean.
105  All of their descriptions will be set to the string "HP Printer".
106  If any of these printers already exists, it will also be modified
107  unless the -s|--skipexisting command line option is also used.
108           
109  $ pkprinters --delete "*"
110 
111  This will completely delete all printers and associated quota information,
112  as well as their job history. USE WITH CARE !
113 
114  $ pkprinters --groups Laser,HP "hp*"
115 
116  This will put all printers which name matches "hp*" into printers groups
117  Laser and HP, which MUST already exist.
118 
119  $ pkprinters --groups LexMark --remove hp2200
120 
121  This will remove the hp2200 printer from the LexMark printer group.
122""")
123       
124class PKPrinters(PyKotaTool) :       
125    """A class for a printers manager."""
126    def main(self, names, options) :
127        """Manage printers."""
128        if (not self.config.isAdmin) and (not options["list"]) :
129            raise PyKotaCommandLineError, "%s : %s" % (pwd.getpwuid(os.geteuid())[0], _("You're not allowed to use this command."))
130           
131        if options["delete"] :   
132            self.display("%s...\n" % _("Deletion"))
133            todelete = self.storage.getMatchingPrinters(",".join(names))
134            nbtotal = len(todelete)
135            for i in range(nbtotal) :
136                entry = todelete[i]
137                if entry.Exists :
138                    entry.delete()
139                percent = 100.0 * float(i) / float(nbtotal)
140                self.display("\r%.02f%%" % percent)
141        else :
142            if options["add"] :   
143                self.display("%s...\n" % _("Creation"))
144                printers = []
145                nbtotal = len(names)
146                for i in range(nbtotal) :
147                    pname = names[i]
148                    printer = self.storage.getPrinter(pname)
149                    if printer.Exists :
150                        if options["skipexisting"] :
151                            self.printInfo(_("Printer %s already exists, skipping.") % printer.Name)
152                        else :   
153                            self.printInfo(_("Printer %s already exists, will be modified.") % printer.Name)
154                            printers.append(printer)
155                    else :
156                        if self.isValidName(pname) :
157                            printer = self.storage.addPrinter(pname)
158                            if not printer.Exists :
159                                raise PyKotaToolError, _("Impossible to add printer %s") % pname
160                            else :   
161                                printers.append(printer)
162                        else :   
163                            raise PyKotaCommandLineError, _("Invalid printer name %s") % pname
164                    percent = 100.0 * float(i) / float(nbtotal)
165                    self.display("\r%.02f%%" % percent)
166                self.display("\r100.00%%\r        \r%s\n" % _("Done."))
167            else :       
168                if not names :
169                    names = ["*"]
170                printers = self.storage.getMatchingPrinters(",".join(names))
171                if not printers :
172                    raise PyKotaCommandLineError, _("There's no printer matching %s") % " ".join(names)
173                       
174            if options["list"] :
175                for printer in printers :
176                    if printer.Exists :
177                        parents = ", ".join([p.Name for p in self.storage.getParentPrinters(printer)])
178                        print "%s [%s] (%s + #*%s)" % \
179                              (printer.Name, printer.Description, printer.PricePerJob, \
180                               printer.PricePerPage)
181                        print "    %s" % (_("Passthrough mode : %s") % ((printer.PassThrough and _("ON")) or _("OFF")))
182                        print "    %s" % (_("Maximum job size : %s") % ((printer.MaxJobSize and (_("%s pages") % printer.MaxJobSize)) or _("Unlimited")))
183                        if parents : 
184                            print "    %s %s" % (_("in"), parents)
185                        print   
186            else :
187                self.display("%s...\n" % _("Modification"))
188               
189                if options["groups"] :       
190                    printersgroups = self.storage.getMatchingPrinters(options["groups"])
191                    if not printersgroups :
192                        raise PyKotaCommandLineError, _("There's no printer matching %s") % " ".join(options["groups"].split(','))
193                else :         
194                    printersgroups = []
195                       
196                if options["charge"] :
197                    try :
198                        charges = [float(part) for part in options["charge"].split(',', 1)]
199                    except ValueError :   
200                        raise PyKotaCommandLineError, _("Invalid charge amount value %s") % options["charge"]
201                    else :   
202                        if len(charges) > 2 :
203                            charges = charges[:2]
204                        if len(charges) != 2 :
205                            charges = [charges[0], None]
206                        (perpage, perjob) = charges
207                       
208                if options["maxjobsize"] :       
209                    try :
210                        maxjobsize = int(options["maxjobsize"])
211                        if maxjobsize < 0 :
212                            raise ValueError
213                    except ValueError :   
214                        raise PyKotaCommandLineError, _("Invalid maximum job size value %s") % options["maxjobsize"]
215                else :       
216                    maxjobsize = None
217                       
218                description = options["description"]
219                if description :
220                    description = description.strip()
221                   
222                nopassthrough = options["nopassthrough"]   
223                passthrough = options["passthrough"]
224                nbtotal = len(printers)
225                for i in range(nbtotal) :       
226                    printer = printers[i]
227                    if options["charge"] :
228                        printer.setPrices(perpage, perjob)   
229                    if description is not None :        # NB : "" is allowed !
230                        printer.setDescription(description)
231                    if nopassthrough and printer.PassThrough :   
232                        printer.setPassThrough(False)
233                    if passthrough and not printer.PassThrough :   
234                        printer.setPassThrough(True)
235                    if (maxjobsize is not None) and (printer.MaxJobSize != maxjobsize) :   
236                        printer.setMaxJobSize(maxjobsize)
237                    printer.save()   
238                    for pgroup in printersgroups :
239                        if options["remove"] :
240                            pgroup.delPrinterFromGroup(printer)
241                        else :
242                            pgroup.addPrinterToGroup(printer)   
243                    percent = 100.0 * float(i) / float(nbtotal)
244                    self.display("\r%.02f%%" % percent)
245                               
246        if not options["list"] :               
247            self.display("\r100.00%%\r        \r%s\n" % _("Done."))
248                     
249if __name__ == "__main__" : 
250    retcode = 0
251    try :
252        short_options = "hvac:D:dg:lrsnpm:"
253        long_options = ["help", "version", "add", "charge=", "description=", \
254                        "delete", "groups=", "list", "remove", \
255                        "skipexisting", "passthrough", "nopassthrough", \
256                        "maxjobsize="]
257       
258        # Initializes the command line tool
259        manager = PKPrinters(doc=__doc__)
260        manager.deferredInit()
261       
262        # parse and checks the command line
263        (options, args) = manager.parseCommandline(sys.argv[1:], short_options, long_options)
264       
265        # sets long options
266        options["help"] = options["h"] or options["help"]
267        options["version"] = options["v"] or options["version"]
268        options["add"] = options["a"] or options["add"]
269        options["charge"] = options["c"] or options["charge"]
270        options["description"] = options["D"] or options["description"]
271        options["delete"] = options["d"] or options["delete"] 
272        options["groups"] = options["g"] or options["groups"]
273        options["list"] = options["l"] or options["list"]
274        options["remove"] = options["r"] or options["remove"]
275        options["skipexisting"] = options["s"] or options["skipexisting"]
276        options["maxjobsize"] = options["m"] or options["maxjobsize"]
277        options["passthrough"] = options["p"] or options["passthrough"]
278        options["nopassthrough"] = options["n"] or options["nopassthrough"]
279       
280        if options["help"] :
281            manager.display_usage_and_quit()
282        elif options["version"] :
283            manager.display_version_and_quit()
284        elif (options["delete"] and (options["add"] or options["groups"] or options["charge"] or options["remove"] or options["description"])) \
285           or (options["skipexisting"] and not options["add"]) \
286           or (options["list"] and (options["add"] or options["delete"] or options["groups"] or options["charge"] or options["remove"] or options["description"])) \
287           or (options["passthrough"] and options["nopassthrough"]) :
288            raise PyKotaCommandLineError, _("incompatible options, see help.")
289        elif options["remove"] and not options["groups"] :   
290            raise PyKotaCommandLineError, _("You have to pass printer groups names on the command line")
291        elif (not args) and (not options["list"]) :   
292            raise PyKotaCommandLineError, _("You have to pass printer names on the command line")
293        else :
294            retcode = manager.main(args, options)
295    except KeyboardInterrupt :       
296        sys.stderr.write("\nInterrupted with Ctrl+C !\n")
297        retcode = -3
298    except PyKotaCommandLineError, msg :   
299        sys.stderr.write("%s : %s\n" % (sys.argv[0], msg))
300        retcode = -2
301    except SystemExit :       
302        pass
303    except :
304        try :
305            manager.crashed("pkprinters failed")
306        except :   
307            crashed("pkprinters failed")
308        retcode = -1
309
310    try :
311        manager.storage.close()
312    except (TypeError, NameError, AttributeError) :   
313        pass
314       
315    sys.exit(retcode)   
Note: See TracBrowser for help on using the browser.