root / pykota / trunk / bin / edpykota @ 2739

Revision 2739, 18.2 kB (checked in by jerome, 18 years ago)

Fixed the problem with deletion time.

  • 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 Print Quota Editor
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 sys
28import os
29import pwd
30import grp
31from pykota.tool import PyKotaTool, PyKotaToolError, PyKotaCommandLineError, crashed, N_
32from pykota.config import PyKotaConfigError
33from pykota.storage import PyKotaStorageError
34
35__doc__ = N_("""edpykota v%(__version__)s (c) %(__years__)s %(__author__)s
36
37A Print Quota editor for PyKota.
38
39command line usage :
40
41  edpykota [options] user1 user2 ... userN
42 
43  edpykota [options] group1 group2 ... groupN
44
45options :
46
47  -v | --version       Prints edpykota's version number then exits.
48  -h | --help          Prints this message then exits.
49 
50  -a | --add           Adds users or groups print quota entries if
51                       they don't exist in database.
52                       
53  -d | --delete        Deletes users or groups print quota entries.
54                       Users or groups are never deleted, you have
55                       to use the pkusers command to delete them.
56                       The history will be purge from all matching
57                       jobs, unless -g | --groups is used.
58 
59  -P | --printer p     Edit quotas on printer p only. Actually p can
60                       use wildcards characters to select only
61                       some printers. The default value is *, meaning
62                       all printers.
63                       You can specify several names or wildcards,
64                       by separating them with commas.
65 
66  -g | --groups        Edit groups print quota entries instead of
67                       users print quota entries.
68                         
69  -L | --list          Lists users or groups print quota entries.
70 
71  -n | --noquota       Sets both soft and hard limits to None for users
72                       or groups print quota entries.
73 
74  -r | --reset         Resets the actual page counter for the user
75                       or group to zero on the specified printers.
76                       The life time page counter is kept unchanged.
77                       
78  -R | --hardreset     Resets the actual and life time page counters
79                       for the user or group to zero on the specified
80                       printers. This is a shortcut for '--used 0'.
81                       
82  -s | --skipexisting  In combination with the --add option above, tells
83                       edpykota to not modify existing print quota entries.
84                       
85  -S | --softlimit sl  Sets the quota soft limit to sl pages.                       
86 
87  -H | --hardlimit hl  Sets the quota hard limit to hl pages.
88 
89  -I | --increase v    Increase existing Soft and Hard limits by the value
90                       of v. You can prefix v with + or -, if no sign is
91                       used, + is assumed.
92
93  -U | --used u        Sets the page counters for the user u pages on
94                       the selected printers. Doesn't work for groups, since
95                       their page counters are the sum of all their members'
96                       page counters.
97                       Useful for migrating users from a different system
98                       where they have already used some pages. Actual
99                       and Life Time page counters may be increased or decreased
100                       if u is prefixed with + or -.
101                       WARNING : BOTH page counters are modified in all cases,
102                       so be careful.
103                       NB : if u equals '0', then the action taken is
104                       the same as if --hardreset was used.
105
106  user1 through userN and group1 through groupN can use wildcards
107  if the --add option is not set.
108 
109examples :                             
110
111  $ edpykota --add john paul george ringo
112 
113  This will create print quota entries for users john, paul, george
114  and ringo on all printers. These print quota entries will have no
115  limit set.
116 
117  $ edpykota --printer lp -S 50 -H 60 jerome
118 
119  This will set jerome's print quota on the lp printer to a soft limit
120  of 50 pages, and a hard limit of 60 pages. Both user jerome and
121  printer lp have been previously created with the pkusers and pkprinters
122  commands, respectively.
123
124  $ edpykota -g -S 500 -H 550 financial support           
125 
126  This will set print quota soft limit to 500 pages and hard limit
127  to 550 pages for groups financial and support on all printers.
128 
129  $ edpykota --reset jerome "jo*"
130 
131  This will reset jerome's page counter to zero on all printers, as
132  well as every user whose name begins with 'jo'.
133  Their life time page counter on each printer will be kept unchanged.
134  You can also reset the life time page counters by using the
135  --hardreset | -R command line option.
136 
137  $ edpykota --printer hpcolor --noquota jerome
138 
139  This will tell PyKota to not limit jerome when printing on the
140  hpcolor printer. All his jobs will be allowed on this printer, but
141  accounting of the pages he prints will still be kept.
142  Print Quotas for jerome on other printers are unchanged.
143 
144  $ edpykota --delete --printer "HP*,XER*" jerome rachel
145 
146  This will delete users jerome and rachel's print quota
147  entries on all printers which name begin with 'HP' or
148  'XER'. The jobs printed by these users on these printers
149  will be deleted from the history.
150""") 
151       
152class EdPyKota(PyKotaTool) :       
153    """A class for edpykota."""
154    def main(self, names, options) :
155        """Edit user or group quotas."""
156        if not self.config.isAdmin :
157            raise PyKotaCommandLineError, "%s : %s" % (pwd.getpwuid(os.geteuid())[0], _("You're not allowed to use this command."))
158       
159        suffix = (options["groups"] and "Group") or "User"       
160        printernames = options["printer"].split(",")
161       
162        if options["delete"] :   
163            self.display("%s...\n" % _("Deletion"))
164            printers = self.storage.getMatchingPrinters(options["printer"])
165            entries = getattr(self.storage, "getMatching%ss" % suffix)(",".join(names))
166            nbtotal = len(entries) * len(printers)
167            i = 0
168            for printer in printers :
169                for entry in entries :
170                    pqentry = getattr(self.storage, "get%sPQuota" % suffix)(entry, printer)
171                    if pqentry.Exists :
172                        pqentry.delete()
173                    i += 1   
174                    percent = 100.0 * float(i) / float(nbtotal)
175                    self.display("\r%.02f%%" % percent)
176        else :
177            if not names :
178                names = ["*"]
179            (printers, entries, pqentries) = getattr(self.storage, "getPrinters%ssAndPQuotas" % suffix)(printernames, names)
180            skipexisting = options["skipexisting"]
181            if options["add"] :
182                self.display("%s...\n" % _("Creation"))
183                mentries = getattr(self.storage, "getMatching%ss" % suffix)(",".join(names))
184                dicnames = {}
185                for m in mentries :
186                    dicnames[m.Name] = None
187                for name in names :
188                    if not dicnames.has_key(name) :
189                        self.printInfo(_("Impossible to create print quota entries if the user or group object %s doesn't already exist. Please use pkusers to create it first.") % name, "warn")
190                mprinters = self.storage.getMatchingPrinters(options["printer"])
191                nbtotal = len(mprinters) * len(mentries)
192                i = 0
193                for printer in mprinters :
194                    pname = printer.Name
195                    for entry in mentries :
196                        ename = entry.Name
197                        pqkey = "%s@%s" % (ename, pname)
198                        if pqentries.has_key(pqkey) and pqentries[pqkey].Exists :
199                            if skipexisting :
200                                self.printInfo(_("%s print quota entry %s@%s already exists, skipping.") % (suffix, ename, pname))
201                                del pqentries[pqkey]
202                            else :   
203                                self.printInfo(_("%s print quota entry %s@%s already exists, will be modified.") % (suffix, ename, pname))
204                        else :       
205                            newpqentry = getattr(self.storage, "add%sPQuota" % suffix)(entry, printer)
206                            if not newpqentry.Exists :
207                                self.printInfo(_("Impossible to create a print quota entry for %s@%s") % (ename, pname))
208                            else :
209                                pqentries[pqkey] = newpqentry
210                        i += 1
211                        percent = 100.0 * float(i) / float(nbtotal)
212                        self.display("\r%.02f%%" % percent)
213                self.display("\r100.00%%\r        \r%s\n" % _("Done."))
214               
215            if not pqentries :
216                raise PyKotaCommandLineError, _("There's no %s print quota entry matching %s") % (suffix.lower(), " ".join(names))
217                   
218            if options["list"] :
219                for (name, entry) in pqentries.items() :
220                    if entry.Exists :
221                        print name
222                        print "    %s" % (_("Page counter : %s") % entry.PageCounter)
223                        print "    %s" % (_("Lifetime page counter : %s") % entry.LifePageCounter)
224                        print "    %s" % (_("Soft limit : %s") % entry.SoftLimit)
225                        print "    %s" % (_("Hard limit : %s") % entry.HardLimit)
226                        print "    %s" % (_("Date limit : %s") % entry.DateLimit)
227                        # TODO : print "    %s" % (_("Maximum job size : %s") % ((entry.MaxJobSize and (_("%s pages") % entry.MaxJobSize)) or _("Unlimited")))
228                        if hasattr(entry, "WarnCount") :
229                            print "    %s" % (_("Warning banners printed : %s") % entry.WarnCount)
230                        print
231            else :
232                self.display("%s...\n" % _("Modification"))
233               
234                used = options["used"]
235                if used :
236                    used = used.strip()
237                    try :
238                        int(used)
239                    except ValueError :
240                        raise PyKotaCommandLineError, _("Invalid used value %s.") % used
241                       
242                increase = options["increase"]
243                if increase :
244                    try :
245                        increase = int(increase.strip())
246                    except ValueError :
247                        raise PyKotaCommandLineError, _("Invalid increase value %s.") % increase
248               
249                softlimit = hardlimit = None
250                noquota = options["noquota"]
251                if not noquota :
252                    if options["softlimit"] :
253                        try :
254                            softlimit = int(options["softlimit"].strip())
255                            if softlimit < 0 :
256                                raise ValueError
257                        except ValueError :   
258                            raise PyKotaCommandLineError, _("Invalid softlimit value %s.") % options["softlimit"]
259                    if options["hardlimit"] :
260                        try :
261                            hardlimit = int(options["hardlimit"].strip())
262                            if hardlimit < 0 :
263                                raise ValueError
264                        except ValueError :   
265                            raise PyKotaCommandLineError, _("Invalid hardlimit value %s.") % options["hardlimit"]
266                    if (softlimit is not None) and (hardlimit is not None) and (hardlimit < softlimit) :       
267                        # error, exchange them
268                        self.printInfo(_("Hard limit %i is less than soft limit %i, values will be exchanged.") % (hardlimit, softlimit))
269                        (softlimit, hardlimit) = (hardlimit, softlimit)
270                    if hardlimit is None :   
271                        hardlimit = softlimit
272                        if hardlimit is not None :
273                            self.printInfo(_("Undefined hard limit set to soft limit (%s) on printer %s.") % (str(hardlimit), printer.Name))
274                    if softlimit is None :   
275                        softlimit = hardlimit
276                        if softlimit is not None :
277                            self.printInfo(_("Undefined soft limit set to hard limit (%s) on printer %s.") % (str(softlimit), printer.Name))
278                   
279                nbtotal = len(pqentries)   
280                i = 0
281                for (pqkey, pqentry) in pqentries.items() :
282                    ename = getattr(pqentry, suffix).Name
283                    pname = pqentry.Printer.Name
284                    if pqentry.Exists :     
285                        if noquota or ((softlimit is not None) and (hardlimit is not None)) :
286                            pqentry.setLimits(softlimit, hardlimit)
287                           
288                        if increase :
289                           if (pqentry.SoftLimit is None) \
290                               or (pqentry.HardLimit is None) :
291                               self.printInfo(_("You can't increase limits by %s when no limit is set.") % increase, "error")
292                           else :
293                               newsoft = pqentry.SoftLimit + increase         
294                               newhard = pqentry.HardLimit + increase         
295                               if (newsoft >= 0) and (newhard >= 0) :
296                                   pqentry.setLimits(newsoft, newhard)
297                               else :   
298                                   self.printInfo(_("You can't set negative limits."), "error")
299                       
300                        if options["reset"] :
301                            pqentry.reset()
302                           
303                        if options["hardreset"] :   
304                            pqentry.hardreset()
305                           
306                        if not options["groups"] :
307                            if used :
308                                pqentry.setUsage(used)
309                               
310                        pqentry.save()       
311                    i += 1           
312                    percent = 100.0 * float(i) / float(nbtotal)
313                    self.display("\r%.02f%%" % percent)
314                               
315        if not options["list"] :               
316            self.display("\r100.00%%\r        \r%s\n" % _("Done."))
317                     
318if __name__ == "__main__" : 
319    retcode = 0
320    try :
321        defaults = { \
322                     "printer" : "*", \
323                   }
324        short_options = "vhdnagrLP:S:H:G:RU:I:s"
325        long_options = ["help", "version", \
326                        "delete", "list", \
327                        "noquota", "add", \
328                        "groups", "reset", "hardreset", \
329                        "printer=", "softlimit=", "hardlimit=", \
330                        "increase=", "used=", "skipexisting"]
331       
332        # Initializes the command line tool
333        manager = EdPyKota(doc=__doc__)
334        manager.deferredInit()
335       
336        # parse and checks the command line
337        (options, args) = manager.parseCommandline(sys.argv[1:], short_options, long_options)
338       
339        # sets long options
340        options["help"] = options["h"] or options["help"]
341        options["version"] = options["v"] or options["version"]
342        options["add"] = options["a"] or options["add"]
343        options["groups"] = options["g"] or options["groups"]
344        options["printer"] = options["P"] or options["printer"] or defaults["printer"]
345        options["softlimit"] = options["S"] or options["softlimit"]
346        options["hardlimit"] = options["H"] or options["hardlimit"] 
347        options["reset"] = options["r"] or options["reset"] 
348        options["noquota"] = options["n"] or options["noquota"]
349        options["delete"] = options["d"] or options["delete"] 
350        options["hardreset"] = options["R"] or options["hardreset"] 
351        options["used"] = options["U"] or options["used"]
352        options["increase"] = options["I"] or options["increase"]
353        options["list"] = options["L"] or options["list"]
354        options["skipexisting"] = options["s"] or options["skipexisting"]
355       
356        if options["help"] :
357            manager.display_usage_and_quit()
358        elif options["version"] :
359            manager.display_version_and_quit()
360        elif (options["add"] and options["delete"]) \
361             or (options["noquota"] and (options["hardlimit"] or options["softlimit"])) \
362             or (options["groups"] and options["used"]) \
363             or (options["skipexisting"] and not options["add"]) :
364            raise PyKotaCommandLineError, _("incompatible options, see help.")
365        elif options["delete"] and not args :
366            raise PyKotaCommandLineError, _("You have to pass user or group names on the command line")
367        else :
368            retcode = manager.main(args, options)
369    except KeyboardInterrupt :       
370        sys.stderr.write("\nInterrupted with Ctrl+C !\n")
371        retcode = -3
372    except PyKotaCommandLineError, msg :     
373        sys.stderr.write("%s : %s\n" % (sys.argv[0], msg))
374        retcode = -2
375    except SystemExit :       
376        pass
377    except :
378        try :
379            manager.crashed("edpykota failed")
380        except :   
381            crashed("edpykota failed")
382        retcode = -1
383
384    try :
385        manager.storage.close()
386    except (TypeError, NameError, AttributeError) :   
387        pass
388       
389    sys.exit(retcode)   
Note: See TracBrowser for help on using the browser.