1 #
2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
3 # This module is free software, and you may redistribute it and/or modify
4 # under the same terms as Python, so long as this copyright message and
5 # disclaimer are retained in their original form.
6 #
7 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
10 # POSSIBILITY OF SUCH DAMAGE.
11 #
12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
17 #
18 # $Id: init.py,v 1.22 2002-09-05 23:39:12 richard Exp $
20 __doc__ = """
21 Init (create) a roundup instance.
22 """
24 import os, sys, errno
26 import roundup.instance, password
27 from roundup import install_util
29 def copytree(src, dst, symlinks=0):
30 """Recursively copy a directory tree using copyDigestedFile().
32 The destination directory os allowed to exist.
34 If the optional symlinks flag is true, symbolic links in the
35 source tree result in symbolic links in the destination tree; if
36 it is false, the contents of the files pointed to by symbolic
37 links are copied.
39 XXX copied from shutil.py in std lib
41 """
42 names = os.listdir(src)
43 try:
44 os.mkdir(dst)
45 except OSError, error:
46 if error.errno != errno.EEXIST: raise
47 for name in names:
48 srcname = os.path.join(src, name)
49 dstname = os.path.join(dst, name)
50 if symlinks and os.path.islink(srcname):
51 linkto = os.readlink(srcname)
52 os.symlink(linkto, dstname)
53 elif os.path.isdir(srcname):
54 copytree(srcname, dstname, symlinks)
55 else:
56 install_util.copyDigestedFile(srcname, dstname)
58 def install(instance_home, template, backend):
59 '''Install an instance using the named template and backend.
61 instance_home - the directory to place the instance data in
62 template - the template to use in creating the instance data
63 backend - the database to use to store the instance data
65 The instance_home directory will be created using the files found in
66 the named template (roundup.templates.<name>). A standard instance_home
67 contains:
68 . instance_config.py
69 - simple configuration of things like the email address for the
70 mail gateway, the mail domain, the mail host, ...
71 . dbinit.py and select_db.py
72 - defines the schema for the hyperdatabase and indicates which
73 backend to use.
74 . interfaces.py
75 - defines the CGI Client and mail gateway MailGW classes that are
76 used by roundup.cgi, roundup-server and roundup-mailgw.
77 . __init__.py
78 - ties together all the instance information into one interface
79 . db/
80 - the actual database that stores the instance's data
81 . html/
82 - the html templates that are used by the CGI Client
83 . detectors/
84 - the auditor and reactor modules for this instance
86 The html directory is typically extracted from the htmlbase module in
87 the template.
88 '''
89 # first, copy the template dir over
90 from roundup.templates import builder
92 # copy the roundup.templates.<template> package contents to the instance dir
93 template_dir = os.path.split(__file__)[0]
94 template_name = template
95 template = os.path.join(template_dir, 'templates', template)
96 copytree(template, instance_home)
98 builder.installHtmlBase(template_name, instance_home)
100 # now select database
101 db = '''# WARNING: DO NOT EDIT THIS FILE!!!
102 from roundup.backends.back_%s import Database, Class, FileClass, IssueClass
103 '''%backend
104 open(os.path.join(instance_home, 'select_db.py'), 'w').write(db)
107 def initialise(instance_home, adminpw):
108 '''Initialise an instance's database
110 adminpw - the password for the "admin" user
111 '''
112 # now import the instance and call its init
113 instance = roundup.instance.open(instance_home)
114 instance.init(password.Password(adminpw))
116 #
117 # $Log: not supported by cvs2svn $
118 # Revision 1.21 2002/08/16 04:25:03 richard
119 # cleanup: moved templatebuilder into templates.builder
120 #
121 # Revision 1.20 2002/07/14 02:05:53 richard
122 # . all storage-specific code (ie. backend) is now implemented by the backends
123 #
124 # Revision 1.19 2002/05/23 01:14:20 richard
125 # . split instance initialisation into two steps, allowing config changes
126 # before the database is initialised.
127 #
128 # Revision 1.18 2001/11/22 15:46:42 jhermann
129 # Added module docstrings to all modules.
130 #
131 # Revision 1.17 2001/11/12 23:17:38 jhermann
132 # Code using copyDigestedFile() that passes unit tests
133 #
134 # Revision 1.16 2001/10/09 07:25:59 richard
135 # Added the Password property type. See "pydoc roundup.password" for
136 # implementation details. Have updated some of the documentation too.
137 #
138 # Revision 1.15 2001/08/07 00:24:42 richard
139 # stupid typo
140 #
141 # Revision 1.14 2001/08/07 00:15:51 richard
142 # Added the copyright/license notice to (nearly) all files at request of
143 # Bizar Software.
144 #
145 # Revision 1.13 2001/08/06 01:20:00 richard
146 # Added documentaion.
147 #
148 # Revision 1.12 2001/08/05 07:43:52 richard
149 # Instances are now opened by a special function that generates a unique
150 # module name for the instances on import time.
151 #
152 # Revision 1.11 2001/08/04 22:42:43 richard
153 # Fixed sf.net bug #447671 - typo
154 #
155 # Revision 1.10 2001/08/03 01:28:33 richard
156 # Used the much nicer load_package, pointed out by Steve Majewski.
157 #
158 # Revision 1.9 2001/08/03 00:59:34 richard
159 # Instance import now imports the instance using imp.load_module so that
160 # we can have instance homes of "roundup" or other existing python package
161 # names.
162 #
163 # Revision 1.8 2001/07/29 07:01:39 richard
164 # Added vim command to all source so that we don't get no steenkin' tabs :)
165 #
166 # Revision 1.7 2001/07/28 07:59:53 richard
167 # Replaced errno integers with their module values.
168 # De-tabbed templatebuilder.py
169 #
170 # Revision 1.6 2001/07/24 11:18:25 anthonybaxter
171 # oops. left a print in
172 #
173 # Revision 1.5 2001/07/24 10:54:11 anthonybaxter
174 # oops. Html.
175 #
176 # Revision 1.4 2001/07/24 10:46:22 anthonybaxter
177 # Added templatebuilder module. two functions - one to pack up the html base,
178 # one to unpack it. Packed up the two standard templates into htmlbases.
179 # Modified __init__ to install them.
180 #
181 # __init__.py magic was needed for the rather high levels of wierd import magic.
182 # Reducing level of import magic == (good, future)
183 #
184 # Revision 1.3 2001/07/23 08:45:28 richard
185 # ok, so now "./roundup-admin init" will ask questions in an attempt to get a
186 # workable instance_home set up :)
187 # _and_ anydbm has had its first test :)
188 #
189 # Revision 1.2 2001/07/22 12:09:32 richard
190 # Final commit of Grande Splite
191 #
192 #
193 # vim: set filetype=python ts=4 sw=4 et si