root / pykota / trunk / bin / autopykota @ 2097

#! /usr/bin/env python
# -*- coding: ISO-8859-15 -*-

# autopykota : script to automate user creation in PyKota
#
# PyKota - Print Quotas for CUPS and LPRng
#
# (c) 2003, 2004, 2005 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.9  2005/01/17 08:44:23  jalet
# Modified copyright years
#
# Revision 1.8  2004/10/21 22:21:21  jalet
# Fixes a string interpolation problem
#
# Revision 1.7  2004/10/13 08:09:19  jalet
# More complete PATH.
# pkhint doesn't use absolute path to search for helper commands anymore.
#
# Revision 1.6  2004/10/11 22:53:05  jalet
# Postponed string interpolation to help message's output method
#
# Revision 1.5  2004/10/11 22:08:06  jalet
# Incorrect doc for autopykota
#
# Revision 1.4  2004/10/11 12:49:05  jalet
# Renders help translatable
#
# Revision 1.3  2004/10/06 07:51:07  jalet
# Now autopykota uses 0.0 as the default value for initial account balance
# if the --initbalance command line option is not used.
#
# Revision 1.2  2004/09/30 11:22:30  jalet
# Extends the PATH and doesn't use absolute path anymore to launch edpykota.
#
# Revision 1.1  2004/09/30 09:52:45  jalet
# Initial release of autopykota. Reading help or manpage is greatly
# encouraged !
#
#
#

import sys
import os

from pykota.tool import PyKotaTool, PyKotaToolError, crashed, N_

__doc__ = N_("""autopykota v%s (c) 2003, 2004, 2005 C@LL - Conseil Internet & Logiciels Libres
A tool to automate user account creation and initial balance setting.

THIS TOOL MUST NOT BE USED IF YOU WANT TO LIMIT YOUR USERS BY PAGE QUOTA !

command line usage :

  THIS TOOL MUST NOT BE USED FROM THE COMMAND LINE BUT ONLY AS PART
  OF AN external policy IN pykota.conf
  
  autopykota { -i | --initbalance value } 

options :

  -v | --version       Prints autopykota's version number then exits.
  -h | --help          Prints this message then exits.
  
  -i | --initbalance b Sets the user's account initial balance value to b.
                       If the user already exists, actual balance is left
                       unmodified. If unset, the default value is 0.
                       
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""")

class AutoPyKota(PyKotaTool) :
    """A class for the automat."""
    def main(self, arguments, options) :
        """Main entry point."""
        os.environ["PATH"] = "%s:/bin:/usr/bin:/usr/local/bin:/opt/bin:/sbin:/usr/sbin" % os.environ.get("PATH", "")
        username = os.environ.get("PYKOTAUSERNAME")
        printername = os.environ.get("PYKOTAPRINTERNAME")
        if (username is None) or (printername is None) :
            raise PyKotaToolError, "Either the username or the printername is undefined. Fatal Error."
        else :
            user = self.storage.getUser(username)
            if user.Exists :
                self.logdebug("User %s already exits." % username) 
                printer = self.storage.getPrinter(printername)
                if printer.Exists :
                    userpquota = self.storage.getUserPQuota(user, printer)
                    if userpquota.Exists :
                        self.logdebug("User %s's quota entry on printer %s already exists. Nothing to do." % (username, printername))
                        return 0
                    else :    
                        self.logdebug("Creating a quota entry for user %s on printer %s." % (username, printername))
                        return os.system('edpykota --add --printer "%s" "%s"' % (printername, username))
                else :
                    self.logdebug("Printer %s doesn't exist. Creating printer %s and a quota entry for user %s on printer %s." % (printername, printername, username, printername))
                    return os.system('edpykota --add --printer "%s" "%s"' % (printername, username))
            else :
                self.logdebug("User %s doesn't exist yet." % username)
                self.logdebug("Creating user %s's account with balance %s and quota entries on all existing printers." % (username, options["initbalance"]))
                return os.system('edpykota --add --limitby balance --balance "%s" "%s"' % (options["initbalance"], username))
    
if __name__ == "__main__" :    
    retcode = 0
    try :
        defaults = { \
                     "initbalance" : 0.0
                   }
        short_options = "vhi:"
        long_options = ["help", "version", "initbalance="]
        
        # Initializes the command line tool
        automat = AutoPyKota(doc=__doc__)
        
        # parse and checks the command line
        (options, args) = automat.parseCommandline(sys.argv[1:], short_options, long_options)
        
        # sets long options
        options["help"] = options["h"] or options["help"]
        options["version"] = options["v"] or options["version"]
        options["initbalance"] = options["i"] or options["initbalance"] or defaults["initbalance"]
        
        if options["help"] :
            automat.display_usage_and_quit()
        elif options["version"] :
            automat.display_version_and_quit()
        elif args :    
            raise PyKotaToolError, "autopykota doesn't accept non option arguments !"
        else :
            retcode = automat.main(args, options)
    except SystemExit :        
        pass
    except :
        try :
            automat.crashed("autopykota failed")
        except :    
            crashed("autopykota failed")
        retcode = -1

    try :
        automat.storage.close()
    except (TypeError, NameError, AttributeError) :    
        pass
        
    sys.exit(retcode)