roundup/templates/classic/dbinit.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: dbinit.py,v 1.16 2002-02-16 08:06:14 richard Exp $
  19
  20 import os
  21
  22 import instance_config
  23 from roundup import roundupdb
  24 import select_db
  25
  26 from roundup.roundupdb import Class, FileClass
  27
  28 class Database(roundupdb.Database, select_db.Database):
  29     ''' Creates a hybrid database from:
  30          . the selected database back-end from select_db
  31          . the roundup extensions from roundupdb
  32     '''
  33     pass
  34
  35 class IssueClass(roundupdb.IssueClass):
  36     ''' issues need the email information
  37     '''
  38     pass
  39
  40
  41 def open(name=None):
  42     ''' as from the roundupdb method openDB
  43
  44     '''
  45     from roundup.hyperdb import String, Password, Date, Link, Multilink
  46
  47     # open the database
  48     db = Database(instance_config, name)
  49
  50     # Now initialise the schema. Must do this each time.
  51     pri = Class(db, "priority",
  52                     name=String(), order=String())
  53     pri.setkey("name")
  54
  55     stat = Class(db, "status",
  56                     name=String(), order=String())
  57     stat.setkey("name")
  58
  59     keyword = Class(db, "keyword",
  60                     name=String())
  61     keyword.setkey("name")
  62
  63     user = Class(db, "user",
  64                     username=String(),   password=Password(),
  65                     address=String(),    realname=String(),
  66                     phone=String(),      organisation=String(),
  67                     alternate_addresses=String())
  68     user.setkey("username")
  69
  70     msg = FileClass(db, "msg",
  71                     author=Link("user"), recipients=Multilink("user"),
  72                     date=Date(),         summary=String(),
  73                     files=Multilink("file"),
  74                     messageid=String(),  inreplyto=String())
  75
  76     file = FileClass(db, "file",
  77                     name=String(),       type=String())
  78
  79     issue = IssueClass(db, "issue",
  80                     assignedto=Link("user"), topic=Multilink("keyword"),
  81                     priority=Link("priority"), status=Link("status"))
  82
  83     import detectors
  84     detectors.init(db)
  85
  86     return db
  87
  88 def init(adminpw):
  89     ''' as from the roundupdb method initDB
  90
  91     Open the new database, and set up a bunch of attributes.
  92
  93     '''
  94     dbdir = os.path.join(instance_config.DATABASE, 'files')
  95     if not os.path.isdir(dbdir):
  96         os.makedirs(dbdir)
  97
  98     db = open("admin")
  99     db.clear()
 100
 101     pri = db.getclass('priority')
 102     pri.create(name="critical", order="1")
 103     pri.create(name="urgent", order="2")
 104     pri.create(name="bug", order="3")
 105     pri.create(name="feature", order="4")
 106     pri.create(name="wish", order="5")
 107
 108     stat = db.getclass('status')
 109     stat.create(name="unread", order="1")
 110     stat.create(name="deferred", order="2")
 111     stat.create(name="chatting", order="3")
 112     stat.create(name="need-eg", order="4")
 113     stat.create(name="in-progress", order="5")
 114     stat.create(name="testing", order="6")
 115     stat.create(name="done-cbb", order="7")
 116     stat.create(name="resolved", order="8")
 117
 118     user = db.getclass('user')
 119     user.create(username="admin", password=adminpw,
 120                                   address=instance_config.ADMIN_EMAIL)
 121     db.commit()
 122
 123 #
 124 # $Log: not supported by cvs2svn $
 125 # Revision 1.15  2002/02/15 07:08:44  richard
 126 #  . Alternate email addresses are now available for users. See the MIGRATION
 127 #    file for info on how to activate the feature.
 128 #
 129 # Revision 1.14  2002/01/14 02:20:15  richard
 130 #  . changed all config accesses so they access either the instance or the
 131 #    config attriubute on the db. This means that all config is obtained from
 132 #    instance_config instead of the mish-mash of classes. This will make
 133 #    switching to a ConfigParser setup easier too, I hope.
 134 #
 135 # At a minimum, this makes migration a _little_ easier (a lot easier in the
 136 # 0.5.0 switch, I hope!)
 137 #
 138 # Revision 1.13  2002/01/02 02:31:38  richard
 139 # Sorry for the huge checkin message - I was only intending to implement #496356
 140 # but I found a number of places where things had been broken by transactions:
 141 #  . modified ROUNDUPDBSENDMAILDEBUG to be SENDMAILDEBUG and hold a filename
 142 #    for _all_ roundup-generated smtp messages to be sent to.
 143 #  . the transaction cache had broken the roundupdb.Class set() reactors
 144 #  . newly-created author users in the mailgw weren't being committed to the db
 145 #
 146 # Stuff that made it into CHANGES.txt (ie. the stuff I was actually working
 147 # on when I found that stuff :):
 148 #  . #496356 ] Use threading in messages
 149 #  . detectors were being registered multiple times
 150 #  . added tests for mailgw
 151 #  . much better attaching of erroneous messages in the mail gateway
 152 #
 153 # Revision 1.12  2001/12/02 05:06:16  richard
 154 # . We now use weakrefs in the Classes to keep the database reference, so
 155 #   the close() method on the database is no longer needed.
 156 #   I bumped the minimum python requirement up to 2.1 accordingly.
 157 # . #487480 ] roundup-server
 158 # . #487476 ] INSTALL.txt
 159 #
 160 # I also cleaned up the change message / post-edit stuff in the cgi client.
 161 # There's now a clearly marked "TODO: append the change note" where I believe
 162 # the change note should be added there. The "changes" list will obviously
 163 # have to be modified to be a dict of the changes, or somesuch.
 164 #
 165 # More testing needed.
 166 #
 167 # Revision 1.11  2001/12/01 07:17:50  richard
 168 # . We now have basic transaction support! Information is only written to
 169 #   the database when the commit() method is called. Only the anydbm
 170 #   backend is modified in this way - neither of the bsddb backends have been.
 171 #   The mail, admin and cgi interfaces all use commit (except the admin tool
 172 #   doesn't have a commit command, so interactive users can't commit...)
 173 # . Fixed login/registration forwarding the user to the right page (or not,
 174 #   on a failure)
 175 #
 176 # Revision 1.10  2001/11/26 22:55:56  richard
 177 # Feature:
 178 #  . Added INSTANCE_NAME to configuration - used in web and email to identify
 179 #    the instance.
 180 #  . Added EMAIL_SIGNATURE_POSITION to indicate where to place the roundup
 181 #    signature info in e-mails.
 182 #  . Some more flexibility in the mail gateway and more error handling.
 183 #  . Login now takes you to the page you back to the were denied access to.
 184 #
 185 # Fixed:
 186 #  . Lots of bugs, thanks Roché and others on the devel mailing list!
 187 #
 188 # Revision 1.9  2001/10/30 00:54:45  richard
 189 # Features:
 190 #  . #467129 ] Lossage when username=e-mail-address
 191 #  . #473123 ] Change message generation for author
 192 #  . MailGW now moves 'resolved' to 'chatting' on receiving e-mail for an issue.
 193 #
 194 # Revision 1.8  2001/10/09 07:25:59  richard
 195 # Added the Password property type. See "pydoc roundup.password" for
 196 # implementation details. Have updated some of the documentation too.
 197 #
 198 # Revision 1.7  2001/08/07 00:24:43  richard
 199 # stupid typo
 200 #
 201 # Revision 1.6  2001/08/07 00:15:51  richard
 202 # Added the copyright/license notice to (nearly) all files at request of
 203 # Bizar Software.
 204 #
 205 # Revision 1.5  2001/08/02 06:38:17  richard
 206 # Roundupdb now appends "mailing list" information to its messages which
 207 # include the e-mail address and web interface address. Templates may
 208 # override this in their db classes to include specific information (support
 209 # instructions, etc).
 210 #
 211 # Revision 1.4  2001/07/29 07:01:39  richard
 212 # Added vim command to all source so that we don't get no steenkin' tabs :)
 213 #
 214 # Revision 1.3  2001/07/24 10:46:22  anthonybaxter
 215 # Added templatebuilder module. two functions - one to pack up the html base,
 216 # one to unpack it. Packed up the two standard templates into htmlbases.
 217 # Modified __init__ to install them.
 218 #
 219 # __init__.py magic was needed for the rather high levels of wierd import magic.
 220 # Reducing level of import magic == (good, future)
 221 #
 222 # Revision 1.2  2001/07/24 01:06:43  richard
 223 # Oops - accidentally duped the keywords class
 224 #
 225 # Revision 1.1  2001/07/23 23:28:43  richard
 226 # Adding the classic template
 227 #
 228 # Revision 1.4  2001/07/23 08:45:28  richard
 229 # ok, so now "./roundup-admin init" will ask questions in an attempt to get a
 230 # workable instance_home set up :)
 231 # _and_ anydbm has had its first test :)
 232 #
 233 # Revision 1.3  2001/07/23 07:14:41  richard
 234 # Moved the database backends off into backends.
 235 #
 236 # Revision 1.2  2001/07/23 06:25:50  richard
 237 # relfected the move to roundup/backends
 238 #
 239 # Revision 1.1  2001/07/23 04:33:21  anthonybaxter
 240 # split __init__.py into 2. dbinit and instance_config.
 241 #
 242 # Revision 1.1  2001/07/23 03:50:46  anthonybaxter
 243 # moved templates to proper location
 244 #
 245 # Revision 1.2  2001/07/22 12:09:32  richard
 246 # Final commit of Grande Splite
 247 #
 248 #
 249 # vim: set filetype=python ts=4 sw=4 et si
 250