[695] | 1 | #! /usr/bin/env python |
---|
| 2 | # |
---|
| 3 | # PyKota |
---|
| 4 | # |
---|
[952] | 5 | # PyKota : Print Quotas for CUPS and LPRng |
---|
[695] | 6 | # |
---|
| 7 | # (c) 2003 Jerome Alet <alet@librelogiciel.com> |
---|
[873] | 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. |
---|
[695] | 12 | # |
---|
[873] | 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. |
---|
[695] | 21 | # |
---|
| 22 | # $Id$ |
---|
| 23 | # |
---|
| 24 | # $Log$ |
---|
[1105] | 25 | # Revision 1.21 2003/07/28 09:11:12 jalet |
---|
| 26 | # PyKota now tries to add its attributes intelligently in existing LDAP |
---|
| 27 | # directories. |
---|
| 28 | # |
---|
[1095] | 29 | # Revision 1.20 2003/07/23 16:51:32 jalet |
---|
| 30 | # waitprinter.sh is now included to prevent PyKota from asking the |
---|
| 31 | # printer's internal page counter while a job is still being printer. |
---|
| 32 | # |
---|
[1087] | 33 | # Revision 1.19 2003/07/16 21:53:07 jalet |
---|
| 34 | # Really big modifications wrt new configuration file's location and content. |
---|
| 35 | # |
---|
[1057] | 36 | # Revision 1.18 2003/07/03 09:44:00 jalet |
---|
| 37 | # Now includes the pykotme utility |
---|
| 38 | # |
---|
[1048] | 39 | # Revision 1.17 2003/06/30 12:46:15 jalet |
---|
| 40 | # Extracted reporting code. |
---|
| 41 | # |
---|
[1018] | 42 | # Revision 1.16 2003/06/06 20:49:15 jalet |
---|
| 43 | # Very latest schema. UNTESTED. |
---|
| 44 | # |
---|
[997] | 45 | # Revision 1.15 2003/05/17 16:32:30 jalet |
---|
| 46 | # Also outputs the original import error message. |
---|
| 47 | # |
---|
[996] | 48 | # Revision 1.14 2003/05/17 16:31:38 jalet |
---|
| 49 | # Dies gracefully if DistUtils is not present. |
---|
| 50 | # |
---|
[973] | 51 | # Revision 1.13 2003/04/29 18:37:54 jalet |
---|
| 52 | # Pluggable accounting methods (actually doesn't support external scripts) |
---|
| 53 | # |
---|
[952] | 54 | # Revision 1.12 2003/04/23 22:13:56 jalet |
---|
| 55 | # Preliminary support for LPRng added BUT STILL UNTESTED. |
---|
| 56 | # |
---|
[940] | 57 | # Revision 1.11 2003/04/17 13:49:29 jalet |
---|
| 58 | # Typo |
---|
| 59 | # |
---|
[939] | 60 | # Revision 1.10 2003/04/17 13:48:39 jalet |
---|
| 61 | # Better help |
---|
| 62 | # |
---|
[938] | 63 | # Revision 1.9 2003/04/17 13:47:28 jalet |
---|
| 64 | # Help added during installation. |
---|
| 65 | # |
---|
[920] | 66 | # Revision 1.8 2003/04/15 17:49:29 jalet |
---|
| 67 | # Installation script now checks the presence of Netatalk |
---|
| 68 | # |
---|
[884] | 69 | # Revision 1.7 2003/04/03 20:03:37 jalet |
---|
| 70 | # Installation script now allows to install the sample configuration file. |
---|
| 71 | # |
---|
[873] | 72 | # Revision 1.6 2003/03/29 13:45:26 jalet |
---|
| 73 | # GPL paragraphs were incorrectly (from memory) copied into the sources. |
---|
| 74 | # Two README files were added. |
---|
| 75 | # Upgrade script for PostgreSQL pre 1.01 schema was added. |
---|
| 76 | # |
---|
[872] | 77 | # Revision 1.5 2003/03/29 13:08:28 jalet |
---|
| 78 | # Configuration is now expected to be found in /etc/pykota.conf instead of |
---|
| 79 | # in /etc/cups/pykota.conf |
---|
| 80 | # Installation script can move old config files to the new location if needed. |
---|
| 81 | # Better error handling if configuration file is absent. |
---|
| 82 | # |
---|
[870] | 83 | # Revision 1.4 2003/03/29 09:47:00 jalet |
---|
| 84 | # More powerful installation script. |
---|
| 85 | # |
---|
[869] | 86 | # Revision 1.3 2003/03/26 17:48:36 jalet |
---|
| 87 | # First shot at trying to detect the availability of the needed software |
---|
| 88 | # during the installation. |
---|
| 89 | # |
---|
[839] | 90 | # Revision 1.2 2003/03/09 16:49:04 jalet |
---|
| 91 | # The installation script installs the man pages too now. |
---|
| 92 | # |
---|
[695] | 93 | # Revision 1.1 2003/02/05 21:28:17 jalet |
---|
| 94 | # Initial import into CVS |
---|
| 95 | # |
---|
| 96 | # |
---|
| 97 | # |
---|
| 98 | |
---|
| 99 | import sys |
---|
| 100 | import glob |
---|
| 101 | import os |
---|
[884] | 102 | import shutil |
---|
[996] | 103 | try : |
---|
| 104 | from distutils.core import setup |
---|
[997] | 105 | except ImportError, msg : |
---|
| 106 | sys.stderr.write("%s\n" % msg) |
---|
[996] | 107 | sys.stderr.write("You need the DistUtils Python module.\nunder Debian, you may have to install the python-dev package.\nOf course, YMMV.\n") |
---|
| 108 | sys.exit(-1) |
---|
[695] | 109 | |
---|
| 110 | sys.path.insert(0, "pykota") |
---|
| 111 | from pykota.version import __version__, __doc__ |
---|
| 112 | |
---|
[870] | 113 | ACTION_CONTINUE = 0 |
---|
| 114 | ACTION_ABORT = 1 |
---|
| 115 | |
---|
| 116 | def checkModule(module) : |
---|
| 117 | """Checks if a Python module is available or not.""" |
---|
[869] | 118 | try : |
---|
[870] | 119 | exec "import %s" % module |
---|
[869] | 120 | except ImportError : |
---|
[870] | 121 | return 0 |
---|
| 122 | else : |
---|
| 123 | return 1 |
---|
| 124 | |
---|
| 125 | def checkCommand(command) : |
---|
| 126 | """Checks if a command is available or not.""" |
---|
| 127 | input = os.popen("type %s 2>/dev/null" % command) |
---|
| 128 | result = input.read().strip() |
---|
| 129 | input.close() |
---|
| 130 | return result |
---|
| 131 | |
---|
[1018] | 132 | def checkWithPrompt(prompt, module=None, command=None, helper=None) : |
---|
[870] | 133 | """Tells the user what will be checked, and asks him what to do if something is absent.""" |
---|
| 134 | sys.stdout.write("Checking for %s availability : " % prompt) |
---|
| 135 | sys.stdout.flush() |
---|
| 136 | if command is not None : |
---|
| 137 | result = checkCommand(command) |
---|
| 138 | elif module is not None : |
---|
| 139 | result = checkModule(module) |
---|
| 140 | if result : |
---|
| 141 | sys.stdout.write("OK\n") |
---|
| 142 | return ACTION_CONTINUE |
---|
| 143 | else : |
---|
| 144 | sys.stdout.write("NO.\n") |
---|
| 145 | sys.stderr.write("ERROR : %s not available !\n" % prompt) |
---|
[1018] | 146 | if helper is not None : |
---|
| 147 | sys.stdout.write("%s\n" % helper) |
---|
[939] | 148 | sys.stdout.write("You may continue safely if you don't need this functionnality.\n") |
---|
[870] | 149 | answer = raw_input("%s is missing. Do you want to continue anyway (y/N) ? " % prompt) |
---|
| 150 | if answer[0:1].upper() == 'Y' : |
---|
| 151 | return ACTION_CONTINUE |
---|
| 152 | else : |
---|
| 153 | return ACTION_ABORT |
---|
| 154 | |
---|
| 155 | if "install" in sys.argv : |
---|
[872] | 156 | # checks if Python version is correct, we need >= 2.1 |
---|
[870] | 157 | if not (sys.version > "2.1") : |
---|
| 158 | sys.stderr.write("PyKota needs at least Python v2.1 !\nYour version seems to be older than that, please update.\nAborted !\n") |
---|
[869] | 159 | sys.exit(-1) |
---|
[870] | 160 | |
---|
[1087] | 161 | # checks if a configuration file is present in the new location |
---|
| 162 | if not os.path.isfile("/etc/pykota/pykota.conf") : |
---|
| 163 | if not os.path.isdir("/etc/pykota") : |
---|
| 164 | try : |
---|
| 165 | os.mkdir("/etc/pykota") |
---|
| 166 | except OSError, msg : |
---|
| 167 | sys.stderr.write("An error occured while creating the /etc/pykota directory.\n%s\n" % msg) |
---|
| 168 | sys.exit(-1) |
---|
| 169 | |
---|
| 170 | if os.path.isfile("/etc/pykota.conf") : |
---|
| 171 | # upgrade from pre-1.14 to 1.14 and above |
---|
| 172 | sys.stdout.write("From version 1.14 on, PyKota expects to find its configuration\nfile in /etc/pykota/ instead of /etc/\n") |
---|
[884] | 173 | sys.stdout.write("It seems that you've got a configuration file in the old location,\nso it will not be used anymore,\nand there's no configuration file in the new location.\n") |
---|
[1087] | 174 | answer = raw_input("Do you want to move /etc/pykota.conf to /etc/pykota/pykota.conf (y/N) ? ") |
---|
[872] | 175 | if answer[0:1].upper() == 'Y' : |
---|
| 176 | try : |
---|
[1087] | 177 | os.rename("/etc/pykota.conf", "/etc/pykota/pykota.conf") |
---|
[872] | 178 | except OSError : |
---|
[1087] | 179 | sys.stderr.write("ERROR : An error occured while moving /etc/pykota.conf to /etc/pykota/pykota.conf\nAborted !\n") |
---|
[872] | 180 | sys.exit(-1) |
---|
[1087] | 181 | else : |
---|
| 182 | sys.stdout.write("Configuration file /etc/pykota.conf moved to /etc/pykota/pykota.conf.\n") |
---|
[872] | 183 | else : |
---|
[1087] | 184 | sys.stderr.write("WARNING : Configuration file /etc/pykota.conf won't be used ! Move it to /etc/pykota/ instead.\n") |
---|
| 185 | sys.stderr.write("PyKota installation will continue anyway,\nbut the software won't run until you put a proper configuration file in /etc/pykota/\n") |
---|
| 186 | dummy = raw_input("Please press ENTER when you have read the message above. ") |
---|
| 187 | else : |
---|
| 188 | # first installation |
---|
| 189 | if os.path.isfile("conf/pykota.conf.sample") : |
---|
| 190 | answer = raw_input("Do you want to install\n\tconf/pykota.conf.sample as /etc/pykota/pykota.conf (y/N) ? ") |
---|
| 191 | if answer[0:1].upper() == 'Y' : |
---|
| 192 | try : |
---|
| 193 | shutil.copy("conf/pykota.conf.sample", "/etc/pykota/pykota.conf") |
---|
| 194 | shutil.copy("conf/pykotadmin.conf.sample", "/etc/pykota/pykotadmin.conf") |
---|
| 195 | except IOError, msg : |
---|
| 196 | sys.stderr.write("WARNING : Problem while installing sample configuration files in /etc/pykota/, please do it manually.\n%s\n" % msg) |
---|
| 197 | else : |
---|
| 198 | sys.stdout.write("Configuration file /etc/pykota/pykota.conf and /etc/pykota/pykotadmin.conf installed.\nDon't forget to adapt these files to your needs.\n") |
---|
| 199 | else : |
---|
| 200 | sys.stderr.write("WARNING : PyKota won't run without a configuration file !\n") |
---|
[884] | 201 | else : |
---|
[1087] | 202 | # Problem ? |
---|
| 203 | sys.stderr.write("WARNING : PyKota's sample configuration file cannot be found.\nWhat you have downloaded seems to be incomplete,\nor you are not in the pykota directory.\nPlease double check, and restart the installation procedure.\n") |
---|
| 204 | dummy = raw_input("Please press ENTER when you have read the message above. ") |
---|
| 205 | else : |
---|
| 206 | # already at 1.14 or above, nothing to be done. |
---|
| 207 | pass |
---|
| 208 | |
---|
| 209 | # Second stage, we will fail if onfiguration is incorrect for security reasons |
---|
| 210 | from pykota.config import PyKotaConfig,PyKotaConfigError |
---|
| 211 | try : |
---|
| 212 | conf = PyKotaConfig("/etc/pykota/") |
---|
| 213 | except PyKotaConfigError, msg : |
---|
| 214 | sys.stedrr.write("%s\nINSTALLATION ABORTED !\nPlease restart installation.\n" % msg) |
---|
| 215 | sys.exit(-1) |
---|
| 216 | else : |
---|
| 217 | hasadmin = conf.getGlobalOption("storageadmin", ignore=1) |
---|
| 218 | hasadminpw = conf.getGlobalOption("storageadminpw", ignore=1) |
---|
| 219 | hasuser = conf.getGlobalOption("storageuser", ignore=1) |
---|
| 220 | if hasadmin or hasadminpw : |
---|
| 221 | sys.stderr.write("From version 1.14 on, PyKota expects that /etc/pykota/pykota.conf doesn't contain the Quota Storage Administrator's name and optional password.\n") |
---|
| 222 | sys.stderr.write("Please put these in a [global] section in /etc/pykota/pykotadmin.conf\n") |
---|
| 223 | sys.stderr.write("Then replace these values with 'storageuser' and 'storageuserpw' in /etc/pykota/pykota.conf\n") |
---|
| 224 | sys.stderr.write("These two fields were re-introduced to allow any user to read to his own quota, without allowing them to modify it.\n") |
---|
| 225 | sys.stderr.write("You can look at the conf/pykota.conf.sample and conf/pykotadmin.conf.sample files for examples.\n") |
---|
| 226 | sys.stderr.write("YOU HAVE TO DO THESE MODIFICATIONS MANUALLY, AND RESTART THE INSTALLATION.\n") |
---|
| 227 | sys.stderr.write("INSTALLATION ABORTED FOR SECURITY REASONS.\n") |
---|
| 228 | sys.exit(-1) |
---|
| 229 | if not hasuser : |
---|
| 230 | sys.stderr.write("From version 1.14 on, PyKota expects that /etc/pykota/pykota.conf contains the Quota Storage Normal User's name and optional password.\n") |
---|
| 231 | sys.stderr.write("Please put these in a [global] section in /etc/pykota/pykota.conf\n") |
---|
| 232 | sys.stderr.write("These fields are respectively named 'storageuser' and 'storageuserpw'.\n") |
---|
| 233 | sys.stderr.write("These two fields were re-introduced to allow any user to read to his own quota, without allowing them to modify it.\n") |
---|
| 234 | sys.stderr.write("You can look at the conf/pykota.conf.sample and conf/pykotadmin.conf.sample files for examples.\n") |
---|
| 235 | sys.stderr.write("YOU HAVE TO DO THESE MODIFICATIONS MANUALLY, AND RESTART THE INSTALLATION.\n") |
---|
| 236 | sys.stderr.write("INSTALLATION ABORTED FOR SECURITY REASONS.\n") |
---|
| 237 | sys.exit(-1) |
---|
| 238 | |
---|
| 239 | sb = conf.getStorageBackend() |
---|
| 240 | if (sb.get("storageadmin") is None) or (sb.get("storageuser") is None) : |
---|
| 241 | sys.stderr.write("From version 1.14 on, PyKota expects that /etc/pykota/pykota.conf contains the Quota Storage Normal User's name and optional password which gives READONLY access to the Print Quota DataBase,") |
---|
| 242 | sys.stderr.write("and that /etc/pykota/pykotadmin.conf contains the Quota Storage Administrator's name and optional password which gives READ/WRITE access to the Print Quota DataBase.\n") |
---|
| 243 | sys.stderr.write("Your configuration doesn't seem to be OK, please modify your configuration files in /etc/pykota/\n") |
---|
| 244 | sys.stderr.write("AND RESTART THE INSTALLATION.\n") |
---|
| 245 | sys.stderr.write("INSTALLATION ABORTED FOR SECURITY REASONS.\n") |
---|
| 246 | sys.exit(-1) |
---|
[1105] | 247 | |
---|
| 248 | # warns for new LDAP fields |
---|
| 249 | if sb.get("storagebackend") == "ldapstorage" : |
---|
| 250 | newuser = conf.getGlobalOption("newuser", ignore=1) |
---|
| 251 | newgroup = conf.getGlobalOption("newgroup", ignore=1) |
---|
| 252 | if not (newuser and newgroup) : |
---|
| 253 | sys.stderr.write("From version 1.14 on, PyKota LDAP Support needs two additional configuration fields.\n") |
---|
| 254 | sys.stderr.write("Please put the 'newuser' and 'newgroup' configuration fields in a [global] section in /etc/pykota/pykota.conf\n") |
---|
| 255 | sys.stderr.write("You can look at the conf/pykota.conf.sample file for examples.\n") |
---|
| 256 | sys.stderr.write("YOU HAVE TO DO THESE MODIFICATIONS MANUALLY, AND RESTART THE INSTALLATION.\n") |
---|
| 257 | sys.stderr.write("INSTALLATION ABORTED BECAUSE CONFIGURATION INCOMPLETE.\n") |
---|
| 258 | sys.exit(-1) |
---|
[1087] | 259 | |
---|
| 260 | # change files permissions |
---|
| 261 | os.chmod("/etc/pykota/pykota.conf", 0644) |
---|
| 262 | os.chmod("/etc/pykota/pykotadmin.conf", 0640) |
---|
[872] | 263 | |
---|
[1087] | 264 | # WARNING MESSAGE |
---|
| 265 | sys.stdout.write("WARNING : IF YOU ARE UPGRADING FROM A PRE-1.14 TO 1.14 OR ABOVE\n") |
---|
| 266 | sys.stdout.write("AND USE THE POSTGRESQL BACKEND, THEN YOU HAVE TO MODIFY YOUR\n") |
---|
| 267 | sys.stdout.write("DATABASE SCHEMA USING initscripts/postgresql/upgrade-to-1.14.sql\n") |
---|
| 268 | sys.stdout.write("PLEASE READ DOCUMENTATION IN initscripts/postgresql/ TO LEARN HOW TO DO.\n") |
---|
| 269 | sys.stdout.write("\n\nYOU DON'T HAVE ANYTHING SPECIAL TO DO IF THIS IS YOUR FIRST INSTALLATION.\n\n") |
---|
| 270 | dummy = raw_input("Please press ENTER when you have read the message above. ") |
---|
| 271 | |
---|
[872] | 272 | # checks if some needed Python modules are there or not. |
---|
[1018] | 273 | modulestocheck = [ ("PygreSQL", "pg", "PygreSQL is mandatory if you want to use PostgreSQL as the quota storage backend."), |
---|
| 274 | ("mxDateTime", "mx.DateTime", "eGenix' mxDateTime is mandatory for PyKota to work."), |
---|
| 275 | ("Python-LDAP", "ldap", "Python-LDAP is mandatory if you plan to use an LDAP\ndirectory as the quota storage backend.") |
---|
| 276 | ] |
---|
[938] | 277 | commandstocheck = [("SNMP Tools", "snmpget", "SNMP Tools are needed if you want to use SNMP enabled printers."), ("Netatalk", "pap", "Netatalk is needed if you want to use AppleTalk enabled printers.")] |
---|
[1018] | 278 | for (name, module, helper) in modulestocheck : |
---|
| 279 | action = checkWithPrompt(name, module=module, helper=helper) |
---|
[870] | 280 | if action == ACTION_ABORT : |
---|
| 281 | sys.stderr.write("Aborted !\n") |
---|
[869] | 282 | sys.exit(-1) |
---|
| 283 | |
---|
[872] | 284 | # checks if some software are there or not. |
---|
[1018] | 285 | for (name, command, helper) in commandstocheck : |
---|
| 286 | action = checkWithPrompt(name, command=command, helper=helper) |
---|
[870] | 287 | if action == ACTION_ABORT : |
---|
| 288 | sys.stderr.write("Aborted !\n") |
---|
| 289 | sys.exit(-1) |
---|
| 290 | |
---|
[695] | 291 | data_files = [] |
---|
| 292 | mofiles = glob.glob(os.sep.join(["po", "*", "*.mo"])) |
---|
| 293 | for mofile in mofiles : |
---|
| 294 | lang = mofile.split(os.sep)[1] |
---|
| 295 | directory = os.sep.join(["share", "locale", lang, "LC_MESSAGES"]) |
---|
| 296 | data_files.append((directory, [ mofile ])) |
---|
[839] | 297 | |
---|
| 298 | directory = os.sep.join(["share", "man", "man1"]) |
---|
| 299 | manpages = glob.glob(os.sep.join(["man", "*.1"])) |
---|
| 300 | data_files.append((directory, manpages)) |
---|
[695] | 301 | |
---|
| 302 | setup(name = "pykota", version = __version__, |
---|
| 303 | license = "GNU GPL", |
---|
| 304 | description = __doc__, |
---|
| 305 | author = "Jerome Alet", |
---|
| 306 | author_email = "alet@librelogiciel.com", |
---|
| 307 | url = "http://www.librelogiciel.com/software/", |
---|
[1048] | 308 | packages = [ "pykota", "pykota.storages", "pykota.requesters", "pykota.loggers", "pykota.accounters", "pykota.reporters" ], |
---|
[1095] | 309 | scripts = [ "bin/pykota", "bin/edpykota", "bin/repykota", "bin/warnpykota", "bin/pykotme", "bin/waitprinter.sh" ], |
---|
[695] | 310 | data_files = data_files) |
---|