root / pykota / trunk / setup.py @ 1130

Revision 1113, 15.8 kB (checked in by jalet, 21 years ago)

1.14 is out !

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