#! /usr/bin/env python

# PyKota Print Quota Warning sender
#
# PyKota - Print Quotas for CUPS
#
# (c) 2003 Jerome Alet <alet@librelogiciel.com>
# You're welcome to redistribute this software under the
# terms of the GNU General Public Licence version 2.0
# or, at your option, any higher version.
#
# You can read the complete GNU GPL in the file COPYING
# which should come along with this software, or visit
# the Free Software Foundation's WEB site http://www.fsf.org
#
# $Id$
#
# $Log$
# Revision 1.10  2003/03/25 11:45:32  jalet
# Clearer help.
#
# Revision 1.9  2003/03/09 23:39:14  jalet
# Simplified translations.
#
# Revision 1.8  2003/02/10 12:07:30  jalet
# Now repykota should output the recorded total page number for each printer too.
#
# Revision 1.7  2003/02/09 13:40:29  jalet
# typo
#
# Revision 1.6  2003/02/09 12:56:53  jalet
# Internationalization begins...
#
# Revision 1.5  2003/02/07 23:24:38  jalet
# Empty line deleted
#
# Revision 1.4  2003/02/06 23:25:40  jalet
# Cleaner docstring
#
# Revision 1.3  2003/02/06 23:20:02  jalet
# warnpykota doesn't need any user/group name argument, mimicing the
# warnquota disk quota tool.
#
# Revision 1.2  2003/02/06 22:54:33  jalet
# warnpykota should be ok
#
#
#

import sys

from pykota import version
from pykota.tool import PyKotaTool, PyKotaToolError

__doc__ = """warnpykota v%s (C) 2003 C@LL - Conseil Internet & Logiciels Libres

Sends mail to users over print quota.

command line usage :

  warnpykota [options] 

options :

  -v | --version       Prints warnpykota's version number then exits.
  -h | --help          Prints this message then exits.
  
  -u | --users         Warns users over their print quota, this is the 
                       default.
  
  -g | --groups        Warns group administrators instead of users,
                       for each group over its print quota.
  
  -P | --printer p     Verify quotas on this printer only. Actually p can
                       use wildcards characters to select only
                       some printers. The default value is *, meaning
                       all printers.
  
examples :                              

  $ warnpykota --printer lp
  
  This will warn all users of the lp printer who have exceeded their
  print quota.

  $ warnpykota 
  
  This will warn all users  who have exceeded their print quota on
  any printer.

  $ warnpykota --groups --printer "laserjet*"
  
  This will warn all group administrators of groups which have exceeded 
  their print quota on any printer which name begins with "laserjet"

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.

Please e-mail bugs to: %s""" % (version.__version__, version.__author__)
        
class WarnPyKota(PyKotaTool) :        
    """A class for warnpykota."""
    def main(self, options) :
        """Warn users or groups over print quota."""
        printernames = self.storage.getMatchingPrinters(options["printer"])
        if not printernames :
            raise PyKotaToolError, _("There's no printer matching %s") % options["printer"]
        for (printer, printerpagecounter) in printernames :
            if options["users"] :
                for name in self.storage.getPrinterUsers(printer) :
                    self.warnUserPQuota(name, printer)
            else :
                for name in self.storage.getPrinterGroups(printer) :
                    self.warnGroupPQuota(name, printer)
                     
if __name__ == "__main__" : 
    try :
        defaults = { \
                     "users"  : 1, \
                     "groups" : 0, \
                     "printer" : "*", \
                   }
        short_options = "vhugP:"
        long_options = ["help", "version", "users", "groups", "printer="]
        
        # Initializes the command line tool
        sender = WarnPyKota(doc=__doc__)
        
        # parse and checks the command line
        (options, args) = sender.parseCommandline(sys.argv[1:], short_options, long_options, allownothing=1)
        
        # sets long options
        options["help"] = options["h"] or options["help"]
        options["version"] = options["v"] or options["version"]
        options["users"] = options["u"] or options["users"] or defaults["users"]
        options["groups"] = options["g"] or options["groups"] or defaults["groups"]
        options["printer"] = options["P"] or options["printer"] or defaults["printer"]
        
        if options["help"] :
            sender.display_usage_and_quit()
        elif options["version"] :
            sender.display_version_and_quit()
        elif options["users"] and options["groups"] :    
            raise PyKotaToolError, _("incompatible options, see help.")
        elif options["groups"] :    
            raise PyKotaToolError, _("option --groups is currently not implemented.")
        elif args :    
            raise PyKotaToolError, _("unused arguments [%s]. Aborting.") % ", ".join(args)
        else :
            sys.exit(sender.main(options))
    except PyKotaToolError, msg :            
        sys.stderr.write("%s\n" % msg)
        sys.stderr.flush()
        sys.exit(-1)