root / pykota / trunk / bin / pykosd @ 2366

Revision 2344, 7.1 kB (checked in by jerome, 19 years ago)

Moved the GPL blurb into a single location.
Now uses named parameters in commands' help.

  • 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 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 time
31
32try :
33    import pyosd
34except ImportError :   
35    sys.stderr.write("Sorry ! You need both xosd and the Python OSD library (pyosd) for this software to work.\n")
36    sys.exit(-1)
37
38from pykota.tool import PyKotaTool, PyKotaToolError, crashed, N_
39
40__doc__ = N_("""pykosd v%(__version__)s (c) %(__years__)s %(__author__)s
41
42An OSD quota monitor for PyKota.
43
44command line usage :
45
46  pykosd [options]
47
48options :
49
50  -v | --version       Prints pykosd's version number then exits.
51  -h | --help          Prints this message then exits.
52 
53  -c | --color #rrggbb Sets the color to use for display as an hexadecimal
54                       triplet, for example #FF0000 is 100%% red.
55                       Defaults to 100%% green (#00FF00).
56                       
57  -d | --duration d    Sets the duration of the display in seconds.
58                       Defaults to 3 seconds.
59                       
60  -f | --font f        Sets the font to use for display.                     
61                       Defaults to the Python OSD library's default.
62 
63  -l | --loop n        Sets the number of times the info will be displayed.
64                       Defaults to 0, which means loop forever.
65                       
66  -s | --sleep s       Sets the sleeping duration between two displays
67                       in seconds. Defaults to 180 seconds (3 minutes).
68                       
69 
70examples :                             
71
72  $ pykosd -s 60 --loop 5
73 
74  Will launch pykosd. Display will be refreshed every 60 seconds,
75  and will last for 3 seconds (the default) each time. After five
76  iterations, the program will exit.
77""")
78
79
80class PyKOSD(PyKotaTool) :
81    def main(self, args, options) :
82        """Main function starts here."""
83        try :   
84            duration = int(options["duration"])
85        except :   
86            raise PyKotaToolError, _("Invalid duration option %s") % str(options["duration"])
87           
88        try :   
89            loop = int(options["loop"])
90        except :   
91            raise PyKotaToolError, _("Invalid loop option %s") % str(options["loop"])
92           
93        try :   
94            sleep = float(options["sleep"])
95        except :   
96            raise PyKotaToolError, _("Invalid sleep option %s") % str(options["sleep"])
97           
98        color = options["color"]   
99        if not color.startswith("#") :
100            color = "#%s" % color
101        if len(color) != 7 :   
102            raise PyKotaToolError, _("Invalid color option %s") % str(color)
103        savecolor = color
104       
105        uname = pwd.getpwuid(os.getuid())[0]
106        while 1 :
107            color = savecolor
108            user = cmd.storage.getUserFromBackend(uname)        # don't use cache
109            if not user.Exists :
110                raise PyKotaToolError, _("User %s doesn't exist in PyKota's database") % uname
111            if user.LimitBy == "quota" :   
112                printers = cmd.storage.getMatchingPrinters("*")
113                upquotas = [ cmd.storage.getUserPQuotaFromBackend(user, p) for p in printers ] # don't use cache
114                nblines = len(upquotas)
115                display = pyosd.osd(font=options["font"], colour=color, timeout=duration, shadow=2, lines=nblines)
116                for line in range(nblines) :
117                    upq = upquotas[line]
118                    if upq.HardLimit is None :
119                        if upq.SoftLimit is None :
120                            percent = "%s" % upq.PageCounter
121                        else :       
122                            percent = "%s%%" % min((upq.PageCounter * 100) / upq.SoftLimit, 100)
123                    else :       
124                        percent = "%s%%" % min((upq.PageCounter * 100) / upq.HardLimit, 100)
125                    display.display(_("Pages used on %s : %s") % (upq.Printer.Name, percent), type=pyosd.TYPE_STRING, line=line)
126            else :
127                if user.AccountBalance <= 0 :
128                    color = "#FF0000"
129                display = pyosd.osd(font=options["font"], colour=color, timeout=duration, shadow=2)
130                display.display(_("PyKota Units left : %.2f") % user.AccountBalance, type=pyosd.TYPE_STRING)
131               
132            time.sleep(duration + 1)
133            if loop :
134                loop -= 1
135                if not loop :
136                    break
137            time.sleep(sleep)       
138           
139        return 0   
140       
141if __name__ == "__main__" :
142    retcode = -1
143    try :
144        defaults = { \
145                     "color" : "#00FF00", \
146                     "duration" : "3", \
147                     "font" : pyosd.default_font, \
148                     "loop" : "0", \
149                     "sleep" : "180", \
150                   }
151        short_options = "hvc:d:f:l:s:"
152        long_options = ["help", "version", "color=", "colour=", "duration=", "font=", "loop=", "sleep="]
153       
154        cmd = PyKOSD(doc=__doc__)
155        cmd.deferredInit()
156       
157        # parse and checks the command line
158        (options, args) = cmd.parseCommandline(sys.argv[1:], short_options, long_options, allownothing=1)
159       
160        # sets long options
161        options["help"] = options["h"] or options["help"]
162        options["version"] = options["v"] or options["version"]
163        options["color"] = options["c"] or options["color"] or options["colour"] or defaults["color"]
164        options["duration"] = options["d"] or options["duration"] or defaults["duration"]
165        options["font"] = options["f"] or options["font"] or defaults["font"]
166        options["loop"] = options["l"] or options["loop"] or defaults["loop"]
167        options["sleep"] = options["s"] or options["sleep"] or defaults["sleep"]
168       
169        if options["help"] :
170            cmd.display_usage_and_quit()
171        elif options["version"] :
172            cmd.display_version_and_quit()
173        else :   
174            retcode = cmd.main(args, options)
175    except KeyboardInterrupt :
176        retcode = 0
177    except KeyboardInterrupt :       
178        sys.stderr.write("\nInterrupted with Ctrl+C !\n")
179    except SystemExit :       
180        pass
181    except :   
182        try :
183            cmd.crashed("pykosd failed")
184        except :   
185            crashed("pykosd failed")
186       
187    try :
188        cmd.storage.close()
189    except :   
190        pass
191       
192    sys.exit(retcode)
Note: See TracBrowser for help on using the browser.