roundup/init.py

   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.25 2003-02-25 10:19:31 richard Exp $
  19
  20 __doc__ = """
  21 Init (create) a roundup instance.
  22 """
  23
  24 import os, sys, errno
  25
  26 import roundup.instance, password
  27 from roundup import install_util
  28
  29 def copytree(src, dst, symlinks=0):
  30     """Recursively copy a directory tree using copyDigestedFile().
  31
  32     The destination directory os allowed to exist.
  33
  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.
  38
  39     This was copied from shutil.py in std lib.
  40     """
  41     names = os.listdir(src)
  42     try:
  43         os.mkdir(dst)
  44     except OSError, error:
  45         if error.errno != errno.EEXIST: raise
  46     for name in names:
  47         srcname = os.path.join(src, name)
  48         dstname = os.path.join(dst, name)
  49         if symlinks and os.path.islink(srcname):
  50             linkto = os.readlink(srcname)
  51             os.symlink(linkto, dstname)
  52         elif os.path.isdir(srcname):
  53             copytree(srcname, dstname, symlinks)
  54         else:
  55             install_util.copyDigestedFile(srcname, dstname)
  56
  57 def install(instance_home, template):
  58     '''Install an instance using the named template and backend.
  59
  60     instance_home - the directory to place the instance data in
  61     template - the template to use in creating the instance data
  62     backend - the database to use to store the instance data
  63
  64     The instance_home directory will be created using the files found in
  65     the named template (roundup.templates.<name>). A standard instance_home
  66     contains:
  67         . config.py
  68           - simple configuration of things like the email address for the
  69             mail gateway, the mail domain, the mail host, ...
  70         . dbinit.py and select_db.py
  71           - defines the schema for the hyperdatabase and indicates which
  72             backend to use.
  73         . interfaces.py
  74           - defines the CGI Client and mail gateway MailGW classes that are
  75             used by roundup.cgi, roundup-server and roundup-mailgw.
  76         . __init__.py
  77           - ties together all the instance information into one interface
  78         . db/
  79           - the actual database that stores the instance's data
  80         . html/
  81           - the html templates that are used by the CGI Client
  82         . detectors/
  83           - the auditor and reactor modules for this instance
  84
  85     The html directory is typically extracted from the htmlbase module in
  86     the template.
  87     '''
  88     # first, copy the template dir over
  89     from roundup.templates import builder
  90
  91     # copy the roundup.templates.<template> package contents to the instance dir
  92     template_dir = os.path.split(__file__)[0]
  93     template_name = template
  94     template = os.path.join(template_dir, 'templates', template)
  95     copytree(template, instance_home)
  96
  97     builder.installHtmlBase(template_name, instance_home)
  98
  99
 100 def write_select_db(instance_home, backend):
 101     ''' Write the file that selects the backend for the tracker
 102     '''
 103     # now select database
 104     db = '''# WARNING: DO NOT EDIT THIS FILE!!!
 105 from roundup.backends.back_%s import Database, Class, FileClass, IssueClass
 106 '''%backend
 107     open(os.path.join(instance_home, 'select_db.py'), 'w').write(db)
 108
 109
 110 def initialise(instance_home, adminpw):
 111     '''Initialise an instance's database
 112
 113     adminpw    - the password for the "admin" user
 114     '''
 115     # now import the instance and call its init
 116     instance = roundup.instance.open(instance_home)
 117     instance.init(password.Password(adminpw))
 118
 119 # vim: set filetype=python ts=4 sw=4 et si