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

Revision 1502, 11.9 kB (checked in by jalet, 21 years ago)

First try at saving the job-originating-hostname in the database

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