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

Revision 1636, 13.8 kB (checked in by jalet, 20 years ago)

Incorrect number of parameters in error method

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