- registration is now a two-step process, with confirmation from the email

[roundup.git] / roundup / init.py

diff --git a/roundup/init.py b/roundup/init.py
index 5e2d31ca5ab5e56daa5a2b64b0b2e7d103378a6b..9a7ffc51241d5c8bb94459809671d1963bee99fe 100644 (file)
--- a/roundup/init.py
+++ b/roundup/init.py
@@ -1,9 +1,33 @@
-# $Id: init.py,v 1.2 2001-07-22 12:09:32 richard Exp $
+#
+# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
+# This module is free software, and you may redistribute it and/or modify
+# under the same terms as Python, so long as this copyright message and
+# disclaimer are retained in their original form.
+#
+# IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+# DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
+# OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+# BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
+# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
+# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+# 
+# $Id: init.py,v 1.25 2003-02-25 10:19:31 richard Exp $
+
+__doc__ = """
+Init (create) a roundup instance.
+"""
+
+import os, sys, errno
 
-import os, shutil, sys
+import roundup.instance, password
+from roundup import install_util
 
 def copytree(src, dst, symlinks=0):
-    """Recursively copy a directory tree using copy2().
+    """Recursively copy a directory tree using copyDigestedFile().
 
     The destination directory os allowed to exist.
 
@@ -12,14 +36,13 @@ def copytree(src, dst, symlinks=0):
     it is false, the contents of the files pointed to by symbolic
     links are copied.
 
-    XXX copied from shutil.py in std lib
-
+    This was copied from shutil.py in std lib.
     """
     names = os.listdir(src)
     try:
         os.mkdir(dst)
     except OSError, error:
-        if error.errno != 17: raise
+        if error.errno != errno.EEXIST: raise
     for name in names:
         srcname = os.path.join(src, name)
         dstname = os.path.join(dst, name)
@@ -29,22 +52,68 @@ def copytree(src, dst, symlinks=0):
         elif os.path.isdir(srcname):
             copytree(srcname, dstname, symlinks)
         else:
-            shutil.copy2(srcname, dstname)
+            install_util.copyDigestedFile(srcname, dstname)
+
+def install(instance_home, template):
+    '''Install an instance using the named template and backend.
+
+    instance_home - the directory to place the instance data in
+    template - the template to use in creating the instance data
+    backend - the database to use to store the instance data
 
-def init(instance, template, adminpw):
-    ''' initialise an instance using the named template
+    The instance_home directory will be created using the files found in
+    the named template (roundup.templates.<name>). A standard instance_home
+    contains:
+        . config.py
+          - simple configuration of things like the email address for the
+            mail gateway, the mail domain, the mail host, ...
+        . dbinit.py and select_db.py
+          - defines the schema for the hyperdatabase and indicates which
+            backend to use.
+        . interfaces.py
+          - defines the CGI Client and mail gateway MailGW classes that are
+            used by roundup.cgi, roundup-server and roundup-mailgw.
+        . __init__.py
+          - ties together all the instance information into one interface
+        . db/
+          - the actual database that stores the instance's data
+        . html/
+          - the html templates that are used by the CGI Client
+        . detectors/
+          - the auditor and reactor modules for this instance
+
+    The html directory is typically extracted from the htmlbase module in
+    the template.
     '''
     # first, copy the template dir over
+    from roundup.templates import builder
+
+    # copy the roundup.templates.<template> package contents to the instance dir
     template_dir = os.path.split(__file__)[0]
+    template_name = template
     template = os.path.join(template_dir, 'templates', template)
-    copytree(template, instance)
+    copytree(template, instance_home)
 
+    builder.installHtmlBase(template_name, instance_home)
+
+
+def write_select_db(instance_home, backend):
+    ''' Write the file that selects the backend for the tracker
+    '''
+    # now select database
+    db = '''# WARNING: DO NOT EDIT THIS FILE!!!
+from roundup.backends.back_%s import Database, Class, FileClass, IssueClass
+'''%backend
+    open(os.path.join(instance_home, 'select_db.py'), 'w').write(db)
+
+
+def initialise(instance_home, adminpw):
+    '''Initialise an instance's database
+
+    adminpw    - the password for the "admin" user
+    '''
     # now import the instance and call its init
-    path, instance = os.path.split(instance)
-    sys.path.insert(0, path)
-    instance = __import__(instance)
-    instance.init(adminpw)
+    instance = roundup.instance.open(instance_home)
+    instance.init(password.Password(adminpw))
 
-#
-# $Log: not supported by cvs2svn $
-#
+# vim: set filetype=python ts=4 sw=4 et si