root / pykota / trunk / pykota / reporter.py @ 2054

# PyKota
# -*- coding: ISO-8859-15 -*-
#
# PyKota : Print Quotas for CUPS and LPRng
#
# (c) 2003-2004 Jerome Alet <alet@librelogiciel.com>
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
#
# $Id$
#
# $Log$
# Revision 1.11  2005/02/13 22:02:29  jalet
# Big database structure changes. Upgrade script is now included as well as
# the new LDAP schema.
# Introduction of the -o | --overcharge command line option to edpykota.
# The output of repykota is more complete, but doesn't fit in 80 columns anymore.
# Introduction of the new 'maxdenybanners' directive.
#
# Revision 1.10  2004/09/02 10:09:30  jalet
# Fixed bug in LDAP user deletion code which didn't correctly delete the user's
# pykotaLastJob entries.
#
# Revision 1.9  2004/07/01 17:45:49  jalet
# Added code to handle the description field for printers
#
# Revision 1.8  2004/03/24 15:15:24  jalet
# Began integration of Henrik Janhagen's work on quota-then-balance
# and balance-then-quota
#
# Revision 1.7  2004/01/08 14:10:32  jalet
# Copyright year changed.
#
# Revision 1.6  2003/12/27 16:49:25  uid67467
# Should be ok now.
#
# Revision 1.4  2003/12/02 14:40:21  jalet
# Some code refactoring.
# New HTML reporter added, which is now used in the CGI script for web based
# print quota reports. It will need some de-uglyfication though...
#
# Revision 1.3  2003/11/25 23:46:40  jalet
# Don't try to verify if module name is valid, Python does this better than us.
#
# Revision 1.2  2003/10/07 09:07:28  jalet
# Character encoding added to please latest version of Python
#
# Revision 1.1  2003/06/30 12:46:15  jalet
# Extracted reporting code.
#
#
#

from mx import DateTime

class PyKotaReporterError(Exception):
    """An exception for Reporter related stuff."""
    def __init__(self, message = ""):
        self.message = message
        Exception.__init__(self, message)
    def __repr__(self):
        return self.message
    __str__ = __repr__
    
class BaseReporter :    
    """Base class for all reports."""
    def __init__(self, tool, printers, ugnames, isgroup) :
        """Initialize local datas."""
        self.tool = tool
        self.printers = printers
        self.ugnames = ugnames
        self.isgroup = isgroup
        
    def getPrinterTitle(self, printer) :     
        return (_("Report for %s quota on printer %s") % ((self.isgroup and "group") or "user", printer.Name)) + (" (%s)" % printer.Description)
        
    def getPrinterGraceDelay(self, printer) :    
        return _("Pages grace time: %i days") % self.tool.config.getGraceDelay(printer.Name)
        
    def getPrinterPrices(self, printer) :    
        return (_("Price per job: %.3f") % (printer.PricePerJob or 0.0), _("Price per page: %.3f") % (printer.PricePerPage or 0.0))
            
    def getReportHeader(self) :        
        if self.isgroup :
            return _("Group          overcharge   used    soft    hard    balance grace         total       paid warn")
        else :    
            return _("User           overcharge   used    soft    hard    balance grace         total       paid warn")
            
    def getPrinterRealPageCounter(self, printer) :        
        msg = _("unknown")
        if printer.LastJob.Exists :
            try :
                msg = "%9i" % printer.LastJob.PrinterPageCounter
            except TypeError :     
                pass
        return _("Real : %s") % msg
                
    def getTotals(self, total, totalmoney) :            
        return (_("Total : %9i") % (total or 0.0), ("%11s" % ("%7.2f" % (totalmoney or 0.0))[:11]))
            
    def getQuota(self, entry, quota) :
        """Prints the quota information."""
        lifepagecounter = int(quota.LifePageCounter or 0)
        pagecounter = int(quota.PageCounter or 0)
        balance = float(entry.AccountBalance or 0.0)
        lifetimepaid = float(entry.LifeTimePaid or 0.0)
        if not hasattr(entry, "OverCharge") :
            overcharge = _("N/A")       # Not available for groups
        else :    
            overcharge = float(entry.OverCharge or 0.0)
        if not hasattr(quota, "WarnCount") :    
            warncount = _("N/A")        # Not available for groups
        else :    
            warncount = int(quota.WarnCount or 0)
        
        #balance
        if entry.LimitBy and (entry.LimitBy.lower() == "balance") :    
            if balance <= 0 :
                datelimit = "DENY"
                reached = "+B"
            elif balance <= self.tool.config.getPoorMan() :
                datelimit = "WARNING"
                reached = "?B"
            else :    
                datelimit = ""
                reached = "-B"

        #balance-then-quota
        elif entry.LimitBy and (entry.LimitBy.lower() == "balance-then-quota") :
            if balance <= 0 :
                if (quota.HardLimit is not None) and (pagecounter >= quota.HardLimit) :
                    datelimit = "DENY"
                elif (quota.HardLimit is None) and (quota.SoftLimit is not None) and (pagecounter >= quota.SoftLimit) :
                    datelimit = "DENY"
                elif quota.DateLimit is not None :
                    now = DateTime.now()
                    datelimit = DateTime.ISO.ParseDateTime(quota.DateLimit)
                    if now >= datelimit :
                        datelimit = "QUOTA_DENY"
                else :
                    datelimit = ""
                reached = ( ((datelimit == "DENY" ) and "+B") or "-Q")
                datelimit = ( ((datelimit == "QUOTA_DENY") and "DENY") or datelimit)
            elif balance <= self.tool.config.getPoorMan() :
                if (quota.HardLimit is not None) and (pagecounter >= quota.HardLimit) :
                    datelimit = "WARNING"
                elif (quota.HardLimit is None) and (quota.SoftLimit is not None) and (pagecounter >= quota.SoftLimit) :
                    datelimit = "WARNING"
                elif quota.DateLimit is not None :
                    now = DateTime.now()
                    datelimit = DateTime.ISO.ParseDateTime(quota.DateLimit)
                    if now >= datelimit :
                        datelimit = "QUOTA_DENY"
                else :
                    datelimit = ""
                reached = ( ((datelimit == "WARNING" ) and "?B") or "+Q")
                datelimit = ( ((datelimit == "QUOTA_DENY") and "WARNING") or datelimit)
            else :
                datelimit = ""
                reached = "-B"

        #Quota-then-balance
        elif entry.LimitBy and (entry.LimitBy.lower() == "quota-then-balance") :
            if (quota.HardLimit is not None) and (pagecounter >= quota.HardLimit) :
                datelimit = "DENY"
            elif (quota.HardLimit is None) and (quota.SoftLimit is not None) and (pagecounter >= quota.SoftLimit) :
                datelimit = "DENY"
            elif quota.DateLimit is not None :
                now = DateTime.now()
                datelimit = DateTime.ISO.ParseDateTime(quota.DateLimit)
                if now >= datelimit :
                    datelimit = "DENY"
            else :
                datelimit = ""
                
            reached = (((quota.SoftLimit is not None) and (pagecounter >= quota.SoftLimit) and "+") or "-") + "Q"

            if (datelimit == "DENY") and (reached == "-Q") and (balance > self.tool.config.getPoorMan()) :
                datelimit = ""
                reached = "-B"
            else :
                reached = (((datelimit == "DENY") and (self.tool.config.getPoorMan() < balance ) and "-B") or reached)
                if (datelimit == "DENY") and (self.tool.config.getPoorMan() < balance) :
                    datelimit = ""
                reached = (((datelimit == "DENY") and (0.0 < balance <= self.tool.config.getPoorMan()) and "?B") or reached)
                datelimit = (((datelimit == "DENY") and (0.0 < balance <= self.tool.config.getPoorMan()) and "WARNING") or datelimit)

        #Quota
        else :
            if (quota.HardLimit is not None) and (pagecounter >= quota.HardLimit) :    
                datelimit = "DENY"
            elif (quota.HardLimit is None) and (quota.SoftLimit is not None) and (pagecounter >= quota.SoftLimit) :
                datelimit = "DENY"
            elif quota.DateLimit is not None :
                now = DateTime.now()
                datelimit = DateTime.ISO.ParseDateTime(quota.DateLimit)
                if now >= datelimit :
                    datelimit = "DENY"
            else :    
                datelimit = ""
            reached = (((quota.SoftLimit is not None) and (pagecounter >= quota.SoftLimit) and "+") or "-") + "Q"
            
        strbalance = ("%5.2f" % balance)[:10]
        strlifetimepaid = ("%6.2f" % lifetimepaid)[:10]
        strovercharge = ("%5s" % overcharge)[:5]
        strwarncount = ("%4s" % warncount)[:4]
        return (lifepagecounter, lifetimepaid, entry.Name, reached, \
                pagecounter, str(quota.SoftLimit), str(quota.HardLimit), \
                strbalance, str(datelimit)[:10], lifepagecounter, \
                strlifetimepaid, strovercharge, strwarncount)
        
def openReporter(tool, reporttype, printers, ugnames, isgroup) :
    """Returns a reporter instance of the proper reporter."""
    try :
        exec "from pykota.reporters import %s as reporterbackend" % reporttype.lower()
    except ImportError :
        raise PyKotaReporterError, _("Unsupported reporter backend %s") % reporttype
    else :    
        return reporterbackend.Reporter(tool, printers, ugnames, isgroup)