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