root / pykota / trunk / cgi-bin / printquota.cgi @ 1582

Revision 1582, 13.1 kB (checked in by jalet, 20 years ago)

Added code to handle the description field for printers

  • 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/python
2
3# PyKota Print Quota Reports generator
4#
5# PyKota - Print Quotas for CUPS and LPRng
6#
7# (c) 2003-2004 Jerome Alet <alet@librelogiciel.com>
8# This program is free software; you can redistribute it and/or modify
9# it under the terms of the GNU General Public License as published by
10# the Free Software Foundation; either version 2 of the License, or
11# (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
21#
22# $Id$
23#
24# $Log$
25# Revision 1.30  2004/07/01 17:45:48  jalet
26# Added code to handle the description field for printers
27#
28# Revision 1.29  2004/06/06 21:07:55  jalet
29# Improved CGI script to allow history on printers and hostnames.
30# Better (?) colors in stylesheet.
31#
32# Revision 1.28  2004/06/05 22:42:41  jalet
33# Improved web history reports
34#
35# Revision 1.27  2004/05/26 14:49:40  jalet
36# First try at saving the job-originating-hostname in the database
37#
38# Revision 1.26  2004/03/24 19:37:04  jalet
39# Doesn't retrieve users or printers objects to display the history,
40# this is not needed, and saves a lot of time (and database queries
41# if storagecahing is disabled)
42#
43# Revision 1.25  2004/01/12 15:28:45  jalet
44# Now can output the user's history on several printers at the same time.
45#
46# Revision 1.24  2004/01/12 14:52:03  jalet
47# Cuts the date string
48#
49# Revision 1.23  2004/01/12 14:35:01  jalet
50# Printing history added to CGI script.
51#
52# Revision 1.22  2004/01/09 07:58:53  jalet
53# Changed URL to PyKota's logo
54#
55# Revision 1.21  2004/01/08 14:10:32  jalet
56# Copyright year changed.
57#
58# Revision 1.20  2004/01/07 16:07:17  jalet
59# The stylesheet is again expected to be local, it was a bad idea to use
60# the one on my server.
61#
62# Revision 1.19  2004/01/06 16:05:45  jalet
63# Will now search the stylesheet on my own website.
64#
65# Revision 1.18  2003/12/27 16:49:25  uid67467
66# Should be ok now.
67#
68# Revision 1.16  2003/12/02 14:40:20  jalet
69# Some code refactoring.
70# New HTML reporter added, which is now used in the CGI script for web based
71# print quota reports. It will need some de-uglyfication though...
72#
73# Revision 1.15  2003/10/24 22:06:42  jalet
74# Initial support for browser's language preference added.
75#
76# Revision 1.14  2003/10/10 19:48:07  jalet
77# Now displays version number
78#
79# Revision 1.13  2003/08/25 11:23:05  jalet
80# More powerful CGI script for quota reports
81#
82# Revision 1.12  2003/07/29 20:55:17  jalet
83# 1.14 is out !
84#
85# Revision 1.11  2003/07/01 12:37:31  jalet
86# Nicer UI
87#
88# Revision 1.10  2003/07/01 07:30:32  jalet
89# Message changed.
90#
91# Revision 1.9  2003/06/30 13:47:26  jalet
92# Allows multiple user / group names masks in the input field
93#
94# Revision 1.8  2003/06/30 13:32:01  jalet
95# Much more powerful CGI script for quota reports
96#
97# Revision 1.7  2003/06/30 12:46:15  jalet
98# Extracted reporting code.
99#
100# Revision 1.6  2003/04/23 22:13:56  jalet
101# Preliminary support for LPRng added BUT STILL UNTESTED.
102#
103# Revision 1.5  2003/04/17 21:30:09  jalet
104# Now includes the logo
105#
106# Revision 1.4  2003/04/08 21:20:25  jalet
107# CGI Script now displays a link to PyKota's website.
108#
109# Revision 1.3  2003/03/29 13:45:27  jalet
110# GPL paragraphs were incorrectly (from memory) copied into the sources.
111# Two README files were added.
112# Upgrade script for PostgreSQL pre 1.01 schema was added.
113#
114# Revision 1.2  2003/02/12 11:31:51  jalet
115# doesn't use the jaxml module anymore
116#
117# Revision 1.1  2003/02/10 13:41:38  jalet
118# repykota cgi script added.
119# cleaner doc.
120#
121
122import sys
123import os
124import cgi
125import urllib
126
127from pykota import version
128from pykota.tool import PyKotaTool, PyKotaToolError
129from pykota.reporter import PyKotaReporterError, openReporter
130
131header = """Content-type: text/html
132
133<?xml version="1.0" encoding="iso-8859-1"?>
134<html>
135  <head>
136    <title>PyKota Reports</title>
137    <link rel="stylesheet" type="text/css" href="/pykota.css" />
138  </head>
139  <body>
140    <form action="printquota.cgi" method="POST">
141      <table>
142        <tr>
143          <td>
144            <p>
145              <a href="http://www.librelogiciel.com/software/"><img src="http://www.librelogiciel.com/software/PyKota/pykota.png" alt="PyKota's Logo" /></a>
146              <br />
147              <a href="http://www.librelogiciel.com/software/">PyKota version %s</a>
148            </p>
149          </td>
150          <td colspan="2">
151            <h1>PyKota Reports</h1>
152          </td>
153        </tr>
154        <tr>
155          <td colspan="3" align="center">
156            <input type="submit" name="action" value="Report" />
157          </td>
158        </tr>
159      </table>"""
160   
161footer = """
162    </form>
163  </body>
164</html>""" 
165
166def getLanguagePreference() :
167    """Returns the preferred language."""
168    languages = os.environ.get("HTTP_ACCEPT_LANGUAGE", "")
169    langs = [l.strip().split(';')[0] for l in languages.split(",")]
170    return "%s_%s" % (langs[0], langs[0].upper())
171
172class PyKotaReportGUI(PyKotaTool) :
173    """PyKota Administrative GUI"""
174       
175    def guiDisplay(self) :
176        """Displays the administrative interface."""
177        global header, footer
178        print header % version.__version__
179        print self.body
180        print footer
181       
182    def error(self, message) :
183        """Adds an error message to the GUI's body."""
184        if message :
185            self.body = '<p><font color="red">%s</font></p>\n%s' % (message, self.body)
186       
187    def htmlListPrinters(self, selected=[], mask="*") :   
188        """Displays the printers multiple selection list."""
189        printers = self.storage.getMatchingPrinters(mask)
190        selectednames = [p.Name for p in selected]
191        message = '<table><tr><td valign="top">Printer :</td><td valign="top"><select name="printers" multiple="multiple">'
192        for printer in printers :
193            if printer.Name in selectednames :
194                message += '<option value="%s" selected="selected">%s (%s)</option>' % (printer.Name, printer.Name, printer.Description)
195            else :
196                message += '<option value="%s">%s (%s)</option>' % (printer.Name, printer.Name, printer.Description)
197        message += '</select></td></tr></table>'
198        return message
199       
200    def htmlUGNamesInput(self, value="*") :   
201        """Input field for user/group names wildcard."""
202        return 'User / Group names mask : <input type="text" name="ugmask" size="20" value="%s" /> <em>e.g. <strong>jo*</strong></em>' % (value or "*")
203       
204    def htmlGroupsCheckbox(self, isgroup=0) :
205        """Groups checkbox."""
206        if isgroup :
207            return 'Groups report : <input type="checkbox" checked="checked" name="isgroup" />'
208        else :   
209            return 'Groups report : <input type="checkbox" name="isgroup" />'
210           
211    def guiAction(self) :
212        """Main function"""
213        printers = ugmask = isgroup = None
214        self.body = "<p>Please click on the button above</p>\n"
215        if self.form.has_key("action") :
216            action = self.form["action"].value
217            if action == "Report" :
218                if self.form.has_key("printers") :
219                    printersfield = self.form["printers"]
220                    if type(printersfield) != type([]) :
221                        printersfield = [ printersfield ]
222                    printers = [self.storage.getPrinter(p.value) for p in printersfield]
223                else :   
224                    printers = self.storage.getMatchingPrinters("*")
225                remuser = os.environ.get("REMOTE_USER", "root")   
226                if remuser == "root" :
227                    if self.form.has_key("ugmask") :     
228                        ugmask = self.form["ugmask"].value
229                    else :     
230                        ugmask = "*"
231                else :       
232                    if self.form.has_key("isgroup") :   
233                        user = self.storage.getUser(remuser)
234                        if user.Exists :
235                            ugmask = " ".join([ g.Name for g in self.storage.getUserGroups(user) ])
236                        else :   
237                            ugmask = remuser # result will probably be empty, we don't care
238                    else :   
239                        ugmask = remuser
240                if self.form.has_key("isgroup") :   
241                    isgroup = 1
242                else :   
243                    isgroup = 0
244            else :
245                self.error(body, "Invalid action [%s]" % action)
246        self.body += self.htmlListPrinters(printers or [])           
247        self.body += "<br />"
248        self.body += self.htmlUGNamesInput(ugmask)
249        self.body += "<br />"
250        self.body += self.htmlGroupsCheckbox(isgroup)
251        if not self.form.has_key("history") :
252            if printers and ugmask :
253                self.reportingtool = openReporter(admin, "html", printers, ugmask.split(), isgroup)
254                self.body += "%s" % self.reportingtool.generateReport()
255        else :       
256            remuser = os.environ.get("REMOTE_USER", "root")   
257            if remuser != "root" :
258                username = remuser
259            elif self.form.has_key("username") :   
260                username = self.form["username"].value
261            else :   
262                username = None
263            if username is not None :   
264                user = self.storage.getUser(username)
265            else :   
266                user =None
267            if self.form.has_key("printername") :
268                printer = self.storage.getPrinter(self.form["printername"].value)
269            else :   
270                printer = None
271            if self.form.has_key("datelimit") :   
272                datelimit = self.form["datelimit"].value
273            else :   
274                datelimit = None
275            if self.form.has_key("hostname") :   
276                hostname = self.form["hostname"].value
277            else :   
278                hostname = None
279            self.report = ["<h2>History</h2>"]   
280            history = self.storage.retrieveHistory(user, printer, datelimit, hostname)
281            if not history :
282                self.report.append("<h3>Empty</h3>")
283            else :
284                self.report.append('<table class="pykotatable" border="1">')
285                headers = ["Date", "Action", "User", "Printer", "Hostname", "JobId", "JobSize", "JobPrice", "Copies", "JobBytes", "PageCounter", "Title", "Filename", "Options"]
286                self.report.append('<tr class="pykotacolsheader">%s</tr>' % "".join(["<th>%s</th>" % h for h in headers]))
287                oddeven = 0
288                for job in history :
289                    oddeven += 1
290                    if oddeven % 2 :
291                        oddevenclass = "odd"
292                    else :   
293                        oddevenclass = "even"
294                    if job.JobAction == "DENY" :
295                        oddevenclass = "deny"
296                    elif job.JobAction == "WARN" :   
297                        oddevenclass = "warn"
298                    username_url = '<a href="%s?%s">%s</a>' % (os.environ.get("SCRIPT_NAME", ""), urllib.urlencode({"history" : 1, "username" : job.UserName}), job.UserName)
299                    printername_url = '<a href="%s?%s">%s</a>' % (os.environ.get("SCRIPT_NAME", ""), urllib.urlencode({"history" : 1, "printername" : job.PrinterName}), job.PrinterName)
300                    if job.JobHostName :
301                        hostname_url = '<a href="%s?%s">%s</a>' % (os.environ.get("SCRIPT_NAME", ""), urllib.urlencode({"history" : 1, "hostname" : job.JobHostName}), job.JobHostName)
302                    else :   
303                        hostname_url = None
304                    self.report.append('<tr class="%s">%s</tr>' % (oddevenclass, "".join(["<td>%s</td>" % (h or "&nbsp;") for h in (job.JobDate[:19], job.JobAction, username_url, printername_url, hostname_url, job.JobId, job.JobSize, job.JobPrice, job.JobCopies, job.JobSizeBytes, job.PrinterPageCounter, job.JobTitle, job.JobFileName, job.JobOptions)])))
305                self.report.append('</table>')
306                dico = { "history" : 1,
307                         "datelimit" : job.JobDate,
308                       }
309                if user and user.Exists :
310                    dico.update({ "username" : user.Name })
311                if printer and printer.Exists :
312                    dico.update({ "printername" : printer.Name })
313                if hostname :   
314                    dico.update({ "hostname" : hostname })
315                prevurl = "%s?%s" % (os.environ.get("SCRIPT_NAME", ""), urllib.urlencode(dico))
316                self.report.append('<a href="%s">Previous page</a>' % prevurl)
317            self.body = "\n".join(self.report)   
318           
319if __name__ == "__main__" :
320    os.environ["LC_ALL"] = getLanguagePreference()
321    admin = PyKotaReportGUI(lang=os.environ["LC_ALL"])
322    admin.form = cgi.FieldStorage()
323    admin.guiAction()
324    admin.guiDisplay()
325    try :
326        admin.storage.close()
327    except (TypeError, NameError, AttributeError) :   
328        pass
329       
330    sys.exit(0)
Note: See TracBrowser for help on using the browser.