root / pykota / trunk / setup.py @ 1147

Revision 1144, 15.9 kB (checked in by jalet, 21 years ago)

Character encoding added to please latest version of Python

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