root / pykoticon / trunk / bin / pykoticon @ 81

Revision 81, 19.9 kB (checked in by jerome, 20 years ago)

Now accept a configuration file on the command line

  • Property svn:keywords set to Id
Line 
1#! /usr/bin/env python
2# -*- coding: ISO-8859-15 -*-
3
4# PyKotIcon - Windows System Tray Icon for PyKota
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#
24
25import sys
26import os
27import urllib
28import urllib2
29import locale
30import gettext
31
32if sys.platform == "win32" :
33    isWindows = 1
34    try :
35        import win32api
36    except ImportError :   
37        raise ImportError, "Mark Hammond's Win32 Extensions are missing. Please install them."
38    else :   
39        iconsdir = "."
40else :       
41    isWindows = 0
42    iconsdir = "/usr/share/pykoticon"   # TODO : change this
43    import pwd
44   
45try :   
46    import wxPython.wx
47    import wx
48    import wx.grid as gridlib
49    hasWxPython = 1
50except ImportError :   
51    hasWxPython = 0
52    raise ImportError, "wxPython is missing. Please install it."
53   
54def getCurrentUserName() :
55    """Retrieves the current user's name."""
56    if isWindows :
57        return win32api.GetUserName()
58    else :   
59        try :
60            return pwd.getpwuid(os.geteuid())[0]
61        except :
62            return "** Unknown **"
63       
64class Printer :
65    """A class for PyKota Printers."""
66    def __init__(self, printername, priceperpage, priceperjob):
67        """Initialize printer datas."""
68        self.PrinterName = printername
69        try :
70            self.PricePerPage = float(priceperpage)
71        except (ValueError, TypeError) :
72            self.PricePerPage = 0.0
73        try :
74            self.PricePerJob = float(priceperjob)
75        except (ValueError, TypeError) :
76            self.PricePerJob = 0.0
77
78class UserQuota :
79    """A class for PyKota User Print Quota entries."""
80    def __init__(self, printername, pagecount, softlimit, hardlimit, datelimit):
81        """Initialize user print quota datas."""
82        self.PrinterName = printername
83        try :
84            self.PageCounter = int(pagecount)
85        except (ValueError, TypeError) :
86            self.PageCounter = 0
87        try :
88            self.SoftLimit = int(softlimit)
89        except (ValueError, TypeError) :
90            self.SoftLimit = None
91        try :
92            self.HardLimit = int(hardlimit)
93        except (ValueError, TypeError) :
94            self.HardLimit = None
95        self.DateLimit = datelimit
96       
97class User :
98    """A class for PyKota users."""
99    def __init__(self, username, userinfo, userquotas, printers) :
100        """Initialize user datas."""
101        self.UserName = username
102        self.LimitBy = userinfo["limitby"][0].lower()
103        try :
104            self.Balance = float(userinfo["balance"][0])
105        except (ValueError, TypeError) :
106            self.Balance = 0.0
107        try :
108            self.LifeTimePaid = float(userinfo["lifetimepaid"][0])
109        except (ValueError, TypeError) :
110            self.LifeTimePaid = 0.0
111        self.Printers = {}   
112        self.Quotas = {}
113        for i in range(len(userquotas["printername"])) :
114            printername = userquotas["printername"][i]
115            try :
116                pindex = printers["printername"].index(printername)
117            except (ValueError, KeyError) :
118                pass
119            else :   
120                self.Printers[printername] = Printer(printername, \
121                                              printers["priceperpage"][pindex],\
122                                              printers["priceperjob"][pindex])
123            pagecounter = userquotas["pagecounter"][i]
124            softlimit = userquotas["softlimit"][i]
125            hardlimit = userquotas["hardlimit"][i]
126            datelimit = userquotas["datelimit"][i]
127            self.Quotas[printername] = UserQuota(printername, pagecounter, \
128                                                   softlimit, hardlimit, \
129                                                              datelimit)
130           
131class CGINetworkInterface :
132    """A class for all network interactions."""
133    def __init__(self, cgiurl, authname=None, authpw=None) :
134        """Initialize CGI connection datas."""
135        self.cgiurl = cgiurl
136        self.authname = authname        # TODO : at least do basic auth
137        self.authpw = authpw
138       
139    def retrieveDatas(self, arguments, fieldnames) :
140        """Retrieve datas from the CGI script."""
141        args = { "report" : 1,
142                 "format" : "csv",
143               } 
144        args.update(arguments)           
145        answer = {}
146        try :           
147            url = "%s?%s" % (self.cgiurl, urllib.urlencode(args))
148            u = urllib2.urlopen(url)
149            lines = u.readlines()
150        except IOError, msg :   
151            raise IOError, _("Unable to retrieve %s : %s") % (url, msg)
152        else :   
153            u.close()
154            try :
155                lines = [ line.strip().split(",") for line in lines ]
156                fields = [field[1:-1] for field in lines[0]]
157                indices = [fields.index(fname) for fname in fieldnames]
158                answer = dict([ (fieldname, \
159                                  [ line[fields.index(fieldname)][1:-1] \
160                                    for line in lines[1:] ]) \
161                                for fieldname in fieldnames ])
162            except :   
163                raise ValueError, _("Invalid datas retrieved from %s") % url
164        return answer
165       
166    def getPrinters(self) :
167        """Retrieve the printer's names."""
168        arguments = { "report" : 1,
169                      "format" : "csv",
170                      "datatype" : "printers",
171                    } 
172        return self.retrieveDatas(arguments, ["printername", "priceperpage", \
173                                              "priceperjob"])
174       
175    def getUser(self, username) :
176        """Retrieve the user's information."""
177        arguments = { "datatype" : "users",
178                      "filter" : "username=%s" % username,
179                    } 
180        return self.retrieveDatas(arguments, ("limitby", "balance", \
181                                                         "lifetimepaid"))
182       
183    def getUserPQuotas(self, username) :
184        """Retrieve the user's print quota information."""
185        arguments = { "datatype" : "upquotas",
186                      "filter" : "username=%s" % username,
187                    } 
188        return self.retrieveDatas(arguments, ("printername", "pagecounter", \
189                                              "softlimit", "hardlimit", \
190                                              "datelimit"))
191                                             
192    def getUserInfo(self, username) :
193        """Retrieves the user account and quota information."""
194        info = self.getUser(username)
195        if info :
196            quotas = self.getUserPQuotas(username)
197            return User(username, info, \
198                                  self.getUserPQuotas(username), \
199                                  self.getPrinters())
200   
201class PyKotIconGrid(gridlib.Grid) :   
202    """A class for user print quota entries."""
203    def __init__(self, parent, user) :
204        gridlib.Grid.__init__(self, parent, -1)
205        nbrows = len(user.Quotas.keys())
206        nbcols = 4
207        if user.LimitBy == "balance" :
208            nbrows += 1
209            nbcols -= 1
210        self.CreateGrid(nbrows, nbcols)
211        self.EnableEditing(False)
212        if user.LimitBy == "balance" :
213            self.SetColLabelValue(0, _("Page Counter"))
214            self.SetColLabelValue(1, _("Price per Page"))
215            self.SetColLabelValue(2, _("Price per Job"))
216            attr = gridlib.GridCellAttr()
217            attr.SetAlignment(wx.ALIGN_RIGHT, wx.ALIGN_CENTRE)
218            attr.SetReadOnly(True)
219            colour = wx.GREEN
220            if user.Balance <= 0.0 :
221                colour = wx.RED
222            attr.SetBackgroundColour(colour)       
223            self.SetColAttr(0, attr)
224            attr = gridlib.GridCellAttr()
225            attr.SetAlignment(wx.ALIGN_RIGHT, wx.ALIGN_CENTRE)
226            attr.SetReadOnly(True)
227            self.SetColAttr(1, attr)
228            self.SetColAttr(2, attr)
229            i = 0
230            for printername in user.Printers.keys() :
231                printer = user.Printers[printername]
232                quota = user.Quotas[printername]
233                self.SetRowLabelValue(i, printername)
234                self.SetCellValue(i, 0, str(quota.PageCounter))
235                self.SetCellValue(i, 1, str(printer.PricePerPage))
236                self.SetCellValue(i, 2, str(printer.PricePerJob))
237                i += 1
238            self.SetRowLabelValue(i, "")
239            self.SetCellValue(i, 0, _("CREDITS :") + (" %.2f" % user.Balance))
240            self.SetCellAlignment(i, 0, wx.ALIGN_CENTRE, wx.ALIGN_CENTRE)
241        else :   
242            self.SetColLabelValue(0, _("Page Counter"))
243            self.SetColLabelValue(1, _("Soft Limit"))
244            self.SetColLabelValue(2, _("Hard Limit"))
245            self.SetColLabelValue(3, _("Date Limit"))
246            attr = gridlib.GridCellAttr()
247            attr.SetAlignment(wx.ALIGN_RIGHT, wx.ALIGN_CENTRE)
248            attr.SetReadOnly(True)
249            self.SetColAttr(0, attr)
250            attr = gridlib.GridCellAttr()
251            attr.SetAlignment(wx.ALIGN_CENTRE, wx.ALIGN_CENTRE)
252            attr.SetReadOnly(True)
253            self.SetColAttr(1, attr)
254            self.SetColAttr(2, attr)
255            self.SetColAttr(3, attr)
256            i = 0
257            for printername in user.Quotas.keys() :
258                quota = user.Quotas[printername]
259                self.SetRowLabelValue(i, printername)
260                self.SetCellValue(i, 0, str(quota.PageCounter))
261                self.SetCellValue(i, 1, str(quota.SoftLimit))
262                self.SetCellValue(i, 2, str(quota.HardLimit))
263                self.SetCellValue(i, 3, str(quota.DateLimit))
264                colour = wx.GREEN
265                if quota.SoftLimit is not None :
266                    if quota.PageCounter >= quota.SoftLimit :
267                        colour = wx.RED
268                elif quota.HardLimit is not None :       
269                    if quota.PageCounter >= quota.HardLimit :
270                        colour = wx.RED
271                self.SetCellBackgroundColour(i, 0, colour)       
272                i += 1
273        self.AutoSize()
274        self.Refresh()
275           
276class PyKotIcon(wxPython.wx.wxFrame):
277    """Main class."""
278    def __init__(self, parent, id):
279        wxPython.wx.wxFrame.__init__(self, parent, -1, \
280               _("PyKota Print Quota for user %s") % getCurrentUserName(), \
281               size = (460, -1), \
282               style = wxPython.wx.wxDEFAULT_FRAME_STYLE \
283                     | wxPython.wx.wxSIZE_AUTO_HEIGHT \
284                     | wxPython.wx.wxSIZE_AUTO_WIDTH \
285                     | wxPython.wx.wxICONIZE \
286                     | wxPython.wx.wxNO_FULL_REPAINT_ON_RESIZE)
287        try :             
288            self.tbicon = wxPython.wx.wxTaskBarIcon()
289        except AttributeError :   
290            self.tbicon = None # No taskbar icon facility, old wxWidgets maybe
291       
292        self.greenicon = wxPython.wx.wxIcon(os.path.join(iconsdir, "pykoticon-green.ico"), \
293                                  wxPython.wx.wxBITMAP_TYPE_ICO)
294        self.redicon = wxPython.wx.wxIcon(os.path.join(iconsdir, "pykoticon-red.ico"), \
295                                  wxPython.wx.wxBITMAP_TYPE_ICO)
296       
297        self.SetIcon(self.greenicon)
298        if self.tbicon is not None :
299            self.tbicon.SetIcon(self.greenicon, "PyKotIcon")
300            wxPython.wx.EVT_TASKBAR_LEFT_DCLICK(self.tbicon, self.OnTaskBarActivate)
301            wxPython.wx.EVT_TASKBAR_RIGHT_UP(self.tbicon, self.OnTaskBarMenu)
302       
303            self.TBMENU_RESTORE = wx.NewId()
304            self.TBMENU_CLOSE = wx.NewId()
305            wxPython.wx.EVT_MENU(self.tbicon, self.TBMENU_RESTORE, \
306                                              self.OnTaskBarActivate)
307            wxPython.wx.EVT_MENU(self.tbicon, self.TBMENU_CLOSE, \
308                                              self.OnTaskBarClose)
309            self.menu = wxPython.wx.wxMenu()
310            self.menu.Append(self.TBMENU_RESTORE, _("Show Print Quota"))
311            self.menu.Append(self.TBMENU_CLOSE, _("Quit"))
312       
313        wxPython.wx.EVT_ICONIZE(self, self.OnIconify)
314        wxPython.wx.EVT_CLOSE(self, self.OnClose)
315       
316        self.TBTIMER = wx.NewId()
317        self.chrono = wxPython.wx.wxTimer(self, self.TBTIMER)
318        wxPython.wx.EVT_TIMER(self, self.TBTIMER, self.OnChronoTimer)
319       
320    def postInit(self, configFile) :   
321        """Loads the configuration file and starts processing."""
322        self.User = None
323        url = None
324        try :
325            # try a file on disk first
326            u = open(configFile)
327        except IOError :   
328            try :
329                # then try through the web
330                u = urllib2.urlopen(configFile)
331            except (ValueError, IOError), msg :   
332                raise IOError, _("Impossible to read configuration file %s : %s") % (configFile, msg)
333        url = u.readline().strip()
334        u.close()
335       
336        if not url :
337            raise ValueError, _("Configuration file %s is incorrect.") % configFile
338        self.networkInterface = CGINetworkInterface(url)
339        self.inTimer = False
340        self.chrono.Start(250) # first time in 0.25 second
341
342    def OnChronoTimer(self, event) :
343        """Retrieves user's data quota information."""
344        # we stop it there, needed because we want to
345        # change the delay the first time.
346        self.chrono.Stop()   
347        if self.inTimer is False : # avoids re-entrance
348            self.inTimer = True
349            try :
350                self.User = self.networkInterface.getUserInfo(getCurrentUserName())
351            except IOError, msg :   
352                sys.stderr.write("ERROR : %s\n" % msg)
353            else :
354                if self.User.LimitBy == "balance" :
355                    if self.User.Balance <= 0.0 :
356                        self.SetIcon(self.redicon)
357                        if self.tbicon is not None :
358                            self.tbicon.SetIcon(self.redicon, "PyKotIcon")
359                    else :   
360                        self.SetIcon(self.greenicon)
361                        if self.tbicon is not None :
362                            self.tbicon.SetIcon(self.greenicon, "PyKotIcon")
363                else :       
364                    isRed = False
365                    for q in self.User.Quotas.keys() :
366                        quota = self.User.Quotas[q]
367                        if quota.SoftLimit is not None :
368                            if quota.PageCounter >= quota.SoftLimit :
369                                isRed = True
370                                break
371                        elif quota.HardLimit is not None :       
372                            if quota.PageCounter >= quota.HardLimit :
373                                isRed = True
374                                break
375                    if isRed is True :
376                        self.SetIcon(self.redicon)
377                        if self.tbicon is not None :
378                            self.tbicon.SetIcon(self.redicon, "PyKotIcon")
379                    else :   
380                        self.SetIcon(self.greenicon)
381                        if self.tbicon is not None :
382                            self.tbicon.SetIcon(self.greenicon, "PyKotIcon")
383                isiconized = self.IsIconized()           
384                if isiconized is False :
385                    self.Iconize(True)
386                isshown = self.IsShown()   
387                if isshown is True :
388                    self.Hide()
389                if hasattr(self, "quotasgrid") :   
390                    self.quotasgrid.Close()
391                    self.quotasgrid.Destroy()
392                    del self.quotasgrid
393                self.quotasgrid = PyKotIconGrid(self, self.User)   
394                if isiconized is False :
395                    self.Iconize(False)
396                if isshown is True :   
397                    self.Show(True)
398                self.Refresh()
399            self.inTimer = False
400        # Now we want it every 3 minutes   
401        #self.chrono.Start(1000 * 60 * 3) # every 3 minutes
402        self.chrono.Start(1000 * 20) # every 20 seconds
403   
404    def OnIconify(self, event) :
405        self.Hide()
406
407    def OnTaskBarActivate(self, event) :
408        if self.IsIconized() :
409            self.Iconize(False)
410        if not self.IsShown() :
411            self.Show(True)
412        self.Raise()
413
414    def OnClose(self, event) :
415        if hasattr(self, "chrono") :
416            self.chrono.Stop()
417            del self.chrono
418        if hasattr(self, "quotasgrid") :
419            self.quotasgrid.Close()
420            self.quotasgrid.Destroy()
421            del self.quotasgrid
422        if hasattr(self, "menu") :
423            self.menu.Destroy()
424            del self.menu
425        if hasattr(self, "tbicon") :
426            self.tbicon.Destroy()
427            del self.tbicon
428        self.Destroy()
429
430    def OnTaskBarMenu(self, evt) :
431        self.tbicon.PopupMenu(self.menu)
432
433    def OnTaskBarClose(self, evt) :
434        self.Close()
435
436class PyKotIconApp(wx.PySimpleApp):
437    def OnInit(self) :
438        try :
439            self.frame = PyKotIcon(None, -1)
440        except :   
441            crashed()
442        return True
443       
444    def postInit(self, configFile) :   
445        """Continues processing."""
446        self.frame.postInit(configFile)
447        self.frame.Show(True)
448       
449def main(conffile):
450    """Program's entry point."""
451    try :
452        locale.setlocale(locale.LC_ALL, "")
453    except (locale.Error, IOError) :
454        sys.stderr.write("Problem while setting locale.\n")
455    try :
456        gettext.install("pykoticon")
457    except :
458        gettext.NullTranslations().install()
459    app = PyKotIconApp()
460    app.postInit(conffile)
461    app.MainLoop()
462   
463def crashed() :   
464    """Minimal crash method."""
465    import traceback
466    lines = []
467    for line in traceback.format_exception(*sys.exc_info()) :
468        lines.extend([l for l in line.split("\n") if l])
469    msg = "ERROR: ".join(["%s\n" % l for l in (["ERROR: PyKotIcon"] + lines)])
470    sys.stderr.write(msg)
471    sys.stderr.flush()
472   
473# def test() :
474#     """Runs in test mode (console)."""
475#     print "Configuration file is ignored."
476#     if len(sys.argv) >= 3 :
477#         username = sys.argv[2]
478#     else :   
479#         username = getCurrentUserName()
480#     net = CGINetworkInterface(DUMPYKOTA_URL)
481#     user = net.getUserInfo(username)
482#     print "UserName : ", user.UserName
483#     print "LimitBy : ", user.LimitBy
484#     print "Balance : ", user.Balance
485#     for printername in user.Quotas.keys() :
486#         quota = user.Quotas[printername]
487#         print "\tPrinterName : ", printername
488#         print "\tPageCounter : ", quota.PageCounter
489#         print "\tSoftLimit : ", quota.SoftLimit
490#         print "\tHardLimit : ", quota.HardLimit
491#         print "\tDateLimit : ", quota.DateLimit
492#         print
493#     for printername in user.Printers.keys() :
494#         printer = user.Printers[printername]
495#         print "\tPrinterName : ", printername
496#         print "\tPrice per Page : ", printer.PricePerPage
497#         print "\tPrice per Job : ", printer.PricePerJob
498#         print
499
500if __name__ == '__main__':
501    if len(sys.argv) >= 2 :
502        arg = sys.argv[1]
503        if arg in ("-v", "--version") :   
504            print "0.1"
505        elif arg in ("-h", "--help") :   
506            print "usage : pykoticon configuration_file"
507        #elif arg == "--test" :
508        #    test()
509        else :
510            main(arg)
511    else :   
512        main("pykoticon.conf")
Note: See TracBrowser for help on using the browser.