annotate doc/upgrading.txt @ 2915:7d97c75e7cba

more docs
author Richard Jones <richard@users.sourceforge.net>
date Tue, 16 Nov 2004 23:36:59 +0000
parents 398a93f386b8
children 15620de288b1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
782
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 ======================================
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 Upgrading to newer versions of Roundup
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 ======================================
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
5 Please read each section carefully and edit your tracker home files
2016
2112962f5bb1 Update documentation for the client.py split and add an upgrade notice.
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 2003
diff changeset
6 accordingly. Note that there is information about upgrade procedures in the
2003
a291bf753037 maintenance -> admin guide
Richard Jones <richard@users.sourceforge.net>
parents: 1911
diff changeset
7 `administration guide`_.
782
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8
2273
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
9 If a specific version transition isn't mentioned here (eg. 0.6.7 to 0.6.8)
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
10 then you don't need to do anything. If you're upgrading from 0.5.6 to
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
11 0.6.8 though, you'll need to check the "0.5 to 0.6" and "0.6.x to 0.6.3"
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
12 steps.
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
13
782
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 .. contents::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15
2282
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
16 Migrating from 0.7.1 to 0.8.0
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
17 =============================
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
18
2819
24a5447725a2 note dropped bsddb and bsddb3;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2737
diff changeset
19 0.8.0 Backend changes
24a5447725a2 note dropped bsddb and bsddb3;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2737
diff changeset
20 ---------------------
24a5447725a2 note dropped bsddb and bsddb3;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2737
diff changeset
21
24a5447725a2 note dropped bsddb and bsddb3;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2737
diff changeset
22 Backends 'bsddb' and 'bsddb3' are removed. If you are using one of these,
2886
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
23 you *must* migrate to another backend before upgrading.
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
24
2819
24a5447725a2 note dropped bsddb and bsddb3;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2737
diff changeset
25
2737
37e2b70105f7 removed safeget() from the API [SF#994750]
Richard Jones <richard@users.sourceforge.net>
parents: 2700
diff changeset
26 0.8.0 API changes
37e2b70105f7 removed safeget() from the API [SF#994750]
Richard Jones <richard@users.sourceforge.net>
parents: 2700
diff changeset
27 -----------------
37e2b70105f7 removed safeget() from the API [SF#994750]
Richard Jones <richard@users.sourceforge.net>
parents: 2700
diff changeset
28
37e2b70105f7 removed safeget() from the API [SF#994750]
Richard Jones <richard@users.sourceforge.net>
parents: 2700
diff changeset
29 Class.safeget() was removed from the API. Test your item ids before calling
37e2b70105f7 removed safeget() from the API [SF#994750]
Richard Jones <richard@users.sourceforge.net>
parents: 2700
diff changeset
30 Class.get() instead.
37e2b70105f7 removed safeget() from the API [SF#994750]
Richard Jones <richard@users.sourceforge.net>
parents: 2700
diff changeset
31
37e2b70105f7 removed safeget() from the API [SF#994750]
Richard Jones <richard@users.sourceforge.net>
parents: 2700
diff changeset
32
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
33 0.8.0 New tracker layout
2700
Richard Jones <richard@users.sourceforge.net>
parents: 2573
diff changeset
34 ------------------------
Richard Jones <richard@users.sourceforge.net>
parents: 2573
diff changeset
35
2889
accb3b411ef6 instructions and method for generating config.ini
Richard Jones <richard@users.sourceforge.net>
parents: 2886
diff changeset
36 The ``config.py`` file has been replaced by ``config.ini``. You may use the
accb3b411ef6 instructions and method for generating config.ini
Richard Jones <richard@users.sourceforge.net>
parents: 2886
diff changeset
37 roundup-admin command "genconfig" to generate a new config file::
2886
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
38
2889
accb3b411ef6 instructions and method for generating config.ini
Richard Jones <richard@users.sourceforge.net>
parents: 2886
diff changeset
39 roundup-admin genconfig <tracker home>/config.ini
2886
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
40
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
41 and modify the values therein based on the contents of your old config.py.
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
42 In most cases, the names of the config variables are the same.
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
43
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
44 The ``select_db.py`` file has been replaced by a file in the ``db``
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
45 directory called ``backend_name``. As you might guess, this file contains
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
46 just the name of the backend. To figure what the contents of yours should
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
47 be, use the following table:
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
48
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
49 ================================ =========================
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
50 ``select_db.py`` contents ``backend_name`` contents
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
51 ================================ =========================
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
52 from back_anydbm import ... anydbm
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
53 from back_metakit import ... metakit
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
54 from back_sqlite import ... sqlite
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
55 from back_mysql import ... mysql
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
56 from back_postgresql import ... postgresql
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
57 ================================ =========================
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
58
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
59 The ``dbinit.py`` file has been split into two new files,
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
60 ``initial_data.py`` and ``schema.py``. The contents of this file are:
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
61
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
62 ``initial_data.py``
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
63 You don't need on of these as your tracker is already initialised.
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
64
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
65 ``schema.py``
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
66 The contents of the ``def open(name=None):`` function go in this file.
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
67
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
68 Copy the lines of that function (down to the next ``def`` statement) from
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
69 the ``dbinit.py`` file and *remove* the leading four spaces on each line
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
70 (if there's 8 leading spaces, only remove 4).
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
71
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
72 Remove the first few lines - those starting with ``from roundup.hyperdb
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
73 import ...`` and the ``db = Database(config, name)`` line.
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
74
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
75 Remove the last few lines starting with ``import detectors`` down to
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
76 ``return db`` inclusive.
0998d1b48182 documentation updates
Richard Jones <richard@users.sourceforge.net>
parents: 2819
diff changeset
77
2915
7d97c75e7cba more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2913
diff changeset
78 There's a new way to write extension code for Roundup - the old
7d97c75e7cba more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2913
diff changeset
79 ``interfaces.py`` file will be ignored. See the `customisation
7d97c75e7cba more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2913
diff changeset
80 documentation`_ for information about how extensions are now written.
2700
Richard Jones <richard@users.sourceforge.net>
parents: 2573
diff changeset
81
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
82
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
83 0.8.0 Permissions Changes
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
84 -------------------------
2282
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
85
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
86 The creation of a new item in the user interfaces is now controlled by the
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
87 "Create" Permission. You will need to add an assignment of this Permission
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
88 to your users who are allowed to create items. The most common form of this
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
89 is the following in your ``schema.py`` added just under the current
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
90 assignation of the Edit Permission::
2282
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
91
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
92 for cl in 'issue', 'file', 'msg', 'query', 'keyword':
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
93 p = db.security.getPermission('Create', cl)
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
94 db.security.addPermissionToRole('User', p)
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
95
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
96 You will need to explicitly let anonymous users access the web interface so
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
97 that regular users are able to see the login form. Note that almost all
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
98 trackers will need this Permission. The only situation where it's not
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
99 required is in a tracker that uses an HTTP Basic Authenticated front-end.
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
100 It's enabled by adding to your ``schema.py``::
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
101
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
102 p = db.security.getPermission('Web Access')
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
103 db.security.addPermissionToRole('Anonymous', p)
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
104
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
105 Finally, you will need to enable permission for your users to edit their
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
106 own details by adding the following to ``schema.py``::
2282
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
107
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
108 # Users should be able to edit their own details. Note that this
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
109 # permission is limited to only the situation where the Viewed or
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
110 # Edited item is their own.
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
111 def own_record(db, userid, itemid):
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
112 '''Determine whether the userid matches the item being accessed.'''
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
113 return userid == itemid
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
114 p = db.security.addPermission(name='View', klass='user', check=own_record,
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
115 description="User is allowed to view their own user details")
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
116 p = db.security.addPermission(name='Edit', klass='user', check=own_record,
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
117 description="User is allowed to edit their own user details")
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
118 db.security.addPermissionToRole('User', p)
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
119
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
120
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
121 0.8.0 Use of TemplatingUtils
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
122 ----------------------------
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
123
2910
5c0e5abcb5e3 doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2907
diff changeset
124 If you used custom python functions in TemplatingUtils, they must
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
125 be moved from interfaces.py to a new file in the ``extensions`` directory.
2910
5c0e5abcb5e3 doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2907
diff changeset
126
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
127 Each Function that should be available through TAL needs to be defined
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
128 as a toplevel function in the newly created file. Furthermore you
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
129 add an inititialization function, that registers the functions with the
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
130 tracker.
2282
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
131
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
132 If you find this too tedious, donfu wrote an automatic init function that
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
133 takes an existing TemplatingUtils class, and registers all class methods
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
134 that do not start with an underscore. The following hack should be placed
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
135 in the ``extensions`` directory alongside other extensions::
2282
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
136
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
137 class TemplatingUtils:
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
138 # copy from interfaces.py
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
139
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
140 def init(tracker):
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
141 util = TemplatingUtils()
2819
24a5447725a2 note dropped bsddb and bsddb3;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2737
diff changeset
142
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
143 def setClient(tu):
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
144 util.client = tu.client
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
145 return util
2819
24a5447725a2 note dropped bsddb and bsddb3;
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2737
diff changeset
146
2907
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
147 def execUtil(name):
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
148 return lambda tu, *args, **kwargs: \
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
149 getattr(setClient(tu), name)(*args, **kwargs)
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
150
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
151 for name in dir(util):
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
152 if callable(getattr(util, name)) and not name.startswith('_'):
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
153 tracker.registerUtil(name, execUtil(name))
bcb4668d4196 more docs
Richard Jones <richard@users.sourceforge.net>
parents: 2889
diff changeset
154
2282
c0e86056739f local character set support
Alexander Smishlajev <a1s@users.sourceforge.net>
parents: 2273
diff changeset
155
2572
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
156 0.8.0 Logging Configuration
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
157 ---------------------------
d15b71b8a85a more logging goodness
Richard Jones <richard@users.sourceforge.net>
parents: 2409
diff changeset
158
2573
71e03be0a25b *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
159 See the `administration guide`_ for information about configuring the new
71e03be0a25b *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
160 logging implemented in 0.8.0.
71e03be0a25b *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2572
diff changeset
161
2374
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
162
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
163 Migrating from 0.7.2 to 0.7.3
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
164 =============================
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
165
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
166 0.7.3 Configuration
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
167 -------------------
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
168
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
169 If you choose, you may specify the directory from which static files are
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
170 served (those which use the URL component ``@@file``). Currently the
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
171 directory defaults to the ``TEMPLATES`` configuration variable. You may
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
172 define a new variable, ``STATIC_FILES`` which overrides this value for
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
173 static files.
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
174
31cb1014300c Switch to using sqlite's own locking mechanisms...
Richard Jones <richard@users.sourceforge.net>
parents: 2293
diff changeset
175
2293
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
176 Migrating from 0.7.0 to 0.7.2
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
177 =============================
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
178
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
179 0.7.2 DEFAULT_TIMEZONE is now required
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
180 --------------------------------------
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
181
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
182 The DEFAULT_TIMEZONE configuration variable is now required. Add the
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
183 following to your tracker's ``config.py`` file::
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
184
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
185 # You may specify a different default timezone, for use when users do not
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
186 # choose their own in their settings.
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
187 DEFAULT_TIMEZONE = 0 # specify as numeric hour offest
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
188
51b34469b7aa mention DEFAULT_TIMEZONE requirement in upgrading doc [SF#952932]
Richard Jones <richard@users.sourceforge.net>
parents: 2282
diff changeset
189
2273
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
190 Migrating from 0.7.0 to 0.7.1
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
191 =============================
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
192
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
193 0.7.1 Permission assignments
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
194 ----------------------------
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
195
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
196 If you allow anonymous access to your tracker, you might need to assign
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
197 some additional View (or Edit if your tracker is that open) permissions
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
198 to the "anonymous" user. To do so, find the code in your ``dbinit.py`` that
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
199 says::
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
200
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
201 for cl in 'issue', 'file', 'msg', 'query', 'keyword':
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
202 p = db.security.getPermission('View', cl)
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
203 db.security.addPermissionToRole('User', p)
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
204 p = db.security.getPermission('Edit', cl)
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
205 db.security.addPermissionToRole('User', p)
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
206 for cl in 'priority', 'status':
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
207 p = db.security.getPermission('View', cl)
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
208 db.security.addPermissionToRole('User', p)
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
209
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
210 Add add a line::
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
211
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
212 db.security.addPermissionToRole('Anonymous', p)
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
213
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
214 next to the existing ``'User'`` lines for the Permissions you wish to
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
215 assign to the anonymous user.
c77483d2cda4 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2263
diff changeset
216
2119
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2114
diff changeset
217
2136
ee3cf6a44f29 queries on a per-user basis, and public queries [SF#891798] :)
Richard Jones <richard@users.sourceforge.net>
parents: 2121
diff changeset
218 Migrating from 0.6 to 0.7
2119
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2114
diff changeset
219 =========================
cc4667ef3f12 Added the ability to toggle where error messages go.
Eddie Parker <eparker@users.sourceforge.net>
parents: 2114
diff changeset
220
2076
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
221 0.7.0 Permission assignments
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
222 ----------------------------
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
223
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
224 Due to a change in the rendering of web widgets, permissions are now
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
225 checked on Classes where they previously weren't (this is a good thing).
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
226
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
227 You will need to add some additional Permission assignments for your
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
228 regular users, or some displays will break. After the following in your
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
229 tracker's ``dbinit.py``::
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
230
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
231 # Assign the access and edit Permissions for issue, file and message
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
232 # to regular users now
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
233 for cl in 'issue', 'file', 'msg', 'query', 'keyword':
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
234 p = db.security.getPermission('View', cl)
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
235 db.security.addPermissionToRole('User', p)
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
236 p = db.security.getPermission('Edit', cl)
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
237 db.security.addPermissionToRole('User', p)
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
238
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
239 add::
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
240
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
241 for cl in 'priority', 'status':
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
242 p = db.security.getPermission('View', cl)
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
243 db.security.addPermissionToRole('User', p)
2a4309450202 security fixes and doc updates
Richard Jones <richard@users.sourceforge.net>
parents: 2059
diff changeset
244
2102
666402433998 Fix some tests.
Richard Jones <richard@users.sourceforge.net>
parents: 2077
diff changeset
245
1800
a3b1b1dcf639 Use getuid(), not figure_curuserid()
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1769
diff changeset
246 0.7.0 Getting the current user id
a3b1b1dcf639 Use getuid(), not figure_curuserid()
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1769
diff changeset
247 ---------------------------------
a3b1b1dcf639 Use getuid(), not figure_curuserid()
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1769
diff changeset
248
2263
d22a40dd33af mmm... grammar
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
249 The Database.curuserid attribute has been removed.
d22a40dd33af mmm... grammar
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
250
d22a40dd33af mmm... grammar
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
251 Any code referencing this attribute should be replaced with a
d22a40dd33af mmm... grammar
Richard Jones <richard@users.sourceforge.net>
parents: 2223
diff changeset
252 call to Database.getuid().
1800
a3b1b1dcf639 Use getuid(), not figure_curuserid()
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1769
diff changeset
253
1813
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
254
1911
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
255 0.7.0 ZRoundup changes
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
256 ----------------------
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
257
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
258 The templates in your tracker's html directory will need updating if you
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
259 wish to use ZRoundup. If you've not modified those files (or some of them),
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
260 you may just copy the new versions from the Roundup source in the
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
261 templates/classic/html directory.
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
262
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
263 If you have modified the html files, then you'll need to manually edit them
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
264 to change all occurances of special form variables from using the colon ":"
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
265 special character to the at "@" special character. That is, variables such
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
266 as::
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
267
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
268 :action :required :template :remove:messages ...
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
269
2223
9b447ac40be3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
270 should become::
1911
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
271
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
272 @action @required @template @remove@messages ...
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
273
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
274 Note that ``tal:`` statements are unaffected. So are TAL expression type
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
275 prefixes such as ``python:`` and ``string:``. Please ask on the
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
276 roundup-users mailing list for help if you're unsure.
f5c804379c85 fixed ZRoundup - mostly changes to classic template
Richard Jones <richard@users.sourceforge.net>
parents: 1882
diff changeset
277
1882
15cfde2c3db8 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1850
diff changeset
278
2913
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
279 0.7.0 Edit collision detection
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
280 ------------------------------
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
281
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
282 Roundup now detects collisions with editing in the web interface (that is,
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
283 two people editing the same item at the same time).
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
284
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
285 You must copy the ``_generic.collision.html`` file from Roundup source in
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
286 the ``templates/classic/html`` directory. to your tracker's ``html``
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
287 directory.
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
288
398a93f386b8 merge from maint-0-7
Richard Jones <richard@users.sourceforge.net>
parents: 2910
diff changeset
289
1835
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
290 Migrating from 0.6.x to 0.6.3
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
291 =============================
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
292
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
293 0.6.3 Configuration
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
294 -------------------
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
295
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
296 You will need to copy the file::
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
297
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
298 templates/classic/detectors/__init__.py
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
299
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
300 to your tracker's ``detectors`` directory, replacing the one already there.
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
301 This fixes a couple of bugs in that file.
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
302
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
303
461d8aa81376 merge from maint branch
Richard Jones <richard@users.sourceforge.net>
parents: 1813
diff changeset
304
1363
f41360211819 oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents: 1308
diff changeset
305 Migrating from 0.5 to 0.6
f41360211819 oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents: 1308
diff changeset
306 =========================
f41360211819 oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents: 1308
diff changeset
307
1813
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
308
1388
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
309 0.6.0 Configuration
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
310 -------------------
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
311
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
312 Introduced EMAIL_FROM_TAG config variable. This value is inserted into
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
313 the From: line of nosy email. If the sending user is "Foo Bar", the
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
314 From: line is usually::
1388
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
315
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
316 "Foo Bar" <issue_tracker@tracker.example>
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
317
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
318 the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so::
1388
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
319
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
320 "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example>
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
321
1455
436eb851045a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1439
diff changeset
322 I've altered the mechanism in the detectors __init__.py module so that it
436eb851045a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1439
diff changeset
323 doesn't cross-import detectors from other trackers (if you run more than one
436eb851045a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1439
diff changeset
324 in a single roundup-server). This change means that you'll need to copy the
436eb851045a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1439
diff changeset
325 __init__.py from roundup/templates/classic/detectors/__init__.py to your
436eb851045a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1439
diff changeset
326 <tracker home>/detectors/__init__.py. Don't worry, the "classic" __init__ is a
436eb851045a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1439
diff changeset
327 one-size-fits-all, so it'll work even if you've added/removed detectors.
436eb851045a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1439
diff changeset
328
1813
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
329 0.6.0 Templating changes
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
330 ------------------------
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
331
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
332 The ``user.item`` template (in the tracker home "templates" directory)
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
333 needs to have the following hidden variable added to its form (between the
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
334 ``<form...>`` and ``</form>`` tags::
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
335
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
336 <input type="hidden" name=":template" value="item">
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
337
1455
436eb851045a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1439
diff changeset
338
1423
52eec576c4a6 reminder
Richard Jones <richard@users.sourceforge.net>
parents: 1402
diff changeset
339 0.6.0 Form handling changes
52eec576c4a6 reminder
Richard Jones <richard@users.sourceforge.net>
parents: 1402
diff changeset
340 ---------------------------
52eec576c4a6 reminder
Richard Jones <richard@users.sourceforge.net>
parents: 1402
diff changeset
341
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
342 Roundup's form handling capabilities have been significantly expanded. This
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
343 should not affect users of 0.5 installations - but if you find you're
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
344 getting errors from form submissions, please ask for help on the Roundup
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
345 users mailing list:
1423
52eec576c4a6 reminder
Richard Jones <richard@users.sourceforge.net>
parents: 1402
diff changeset
346
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
347 http://lists.sourceforge.net/lists/listinfo/roundup-users
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
348
1741
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
349 See the customisation doc section on `Form Values`__ for documentation of the
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
350 new form variables possible.
1439
0634f815b90c rfc2822-ify the tracker name in mail headers
Richard Jones <richard@users.sourceforge.net>
parents: 1423
diff changeset
351
1741
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
352 __ customizing.html#form-values
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
353
1423
52eec576c4a6 reminder
Richard Jones <richard@users.sourceforge.net>
parents: 1402
diff changeset
354
1388
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
355 0.6.0 Multilingual character set support
cd28e3b5db2e small cleanup, more info on config changes
Richard Jones <richard@users.sourceforge.net>
parents: 1386
diff changeset
356 ----------------------------------------
1363
f41360211819 oops, forgot upgrade note
Richard Jones <richard@users.sourceforge.net>
parents: 1308
diff changeset
357
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
358 Added internationalization support. This is done via encoding all data
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
359 stored in roundup database to utf-8 (unicode encoding). To support utf-8 in
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
360 web interface you should add the folowing line to your tracker's html/page
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
361 and html/_generic.help files inside <head> tag::
1386
7ca01821df2c notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1381
diff changeset
362
7ca01821df2c notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1381
diff changeset
363 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
7ca01821df2c notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1381
diff changeset
364
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
365 Since latin characters in utf-8 have the same codes as in ASCII table, this
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
366 modification is optional for users who use only plain latin characters.
1386
7ca01821df2c notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1381
diff changeset
367
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
368 After this modification, you will be able to see and enter any world
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
369 character via web interface. Data received via mail interface also converted
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
370 to utf-8, however only new messages will be converted. If your roundup
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
371 database contains some of non-ASCII characters in one of 8-bit encoding,
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
372 they will not be visible in new unicode environment. Some of such data (e.g.
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
373 user names, keywords, etc) can be edited by administrator, the others
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
374 (e.g. messages' contents) is not editable via web interface. Currently there
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
375 is no tool for converting such data, the only solution is to close
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
376 appropriate old issues and create new ones with the same content.
1386
7ca01821df2c notes about upgrading to unicode
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1381
diff changeset
377
1813
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
378
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
379 0.6.0 User timezone support
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
380 ---------------------------
1402
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
381
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
382 From version 0.6.0 roundup supports displaying of Date data in user' local
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
383 timezone if he/she has provided timezone information. To make it possible
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
384 some modification to tracker's schema and HTML templates are required.
1769
5fed70f96d2b various minor bugfixes
Richard Jones <richard@users.sourceforge.net>
parents: 1758
diff changeset
385 First you must add string property 'timezone' to user class in dbinit.py
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
386 like this::
1402
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
387
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
388 user = Class(db, "user",
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
389 username=String(), password=Password(),
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
390 address=String(), realname=String(),
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
391 phone=String(), organisation=String(),
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
392 alternate_addresses=String(),
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
393 queries=Multilink('query'), roles=String(),
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
394 timezone=String())
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
395
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
396 And second - html interface. Add following lines to
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
397 $TRACKER_HOME/html/user.item template::
1402
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
398
1560
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1455
diff changeset
399 <tr>
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1455
diff changeset
400 <th>Timezone</th>
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1455
diff changeset
401 <td tal:content="structure context/timezone/field">timezone</td>
3f2e516b8de3 doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1455
diff changeset
402 </tr>
1402
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
403
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
404 After that all users should be able to provide their timezone information.
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
405 Timezone should be a positive or negative integer - offset from GMT.
1402
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
406
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
407 After providing timezone, roundup will show all dates values, found in web
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
408 and mail interfaces in local time. It will also accept any Date info in
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
409 local time, convert and store it in GMT.
1402
27586da5557c Added users' timezone support
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1388
diff changeset
410
1813
6c2cff78d6a0 added note about hidden :template var in user.item ([SF#799842])
Richard Jones <richard@users.sourceforge.net>
parents: 1800
diff changeset
411
1741
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
412 0.6.0 Search page structure
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
413 ---------------------------
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
414
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
415 In order to accomodate query editing the search page has been restructured. If
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
416 you want to provide your users with query editing, you should update your
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
417 search page using the macros detailed in the customisation doc section
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
418 `Searching on categories`__.
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
419
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
420 __ customizing.html#searching-on-categories
3d4ad125662b Added a little text about the new search page structure.?b
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1638
diff changeset
421
1758
5e1680c11bed Added text about removing '?' from url field when upgrading [SF#790326].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1741
diff changeset
422 Also, the url field in the query class no longer starts with a '?'. You'll need
1850
6e80f8f760a4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1837
diff changeset
423 to remove this question mark from the url field to support queries. There's
6e80f8f760a4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1837
diff changeset
424 a script in the "tools" directory called ``migrate-queries.py`` that should
6e80f8f760a4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1837
diff changeset
425 automatically change any existing queries for you. As always, make a backup
6e80f8f760a4 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 1837
diff changeset
426 of your database before running such a script.
1758
5e1680c11bed Added text about removing '?' from url field when upgrading [SF#790326].
Johannes Gijsbers <jlgijsbers@users.sourceforge.net>
parents: 1741
diff changeset
427
1596
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1560
diff changeset
428
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1560
diff changeset
429 0.6.0 Notes for metakit backend users
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1560
diff changeset
430 -------------------------------------
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1560
diff changeset
431
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
432 Roundup 0.6.0 introduced searching on ranges of dates and intervals. To
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
433 support it, some modifications to interval storing routine were made. So if
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
434 your tracker uses metakit backend and your db schema contains intervals
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
435 property, searches on that property will not be accurate for db items that
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
436 was stored before roundup' upgrade. However all new records should be
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
437 searchable on intervals.
1596
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1560
diff changeset
438
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
439 It is possible to convert your database to new format: you can export and
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
440 import back all your data (consult "Migrating backends" in "Maintenance"
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
441 documentation). After this operation all your interval properties should
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
442 become searchable.
1596
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1560
diff changeset
443
1638
4a47eb555e51 more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1596
diff changeset
444 Users of backends others than metakit should not worry about this issue.
1596
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1560
diff changeset
445
33a0d94c7658 searching on ranges of intervals is implemented
Andrey Lebedev <kedder@users.sourceforge.net>
parents: 1560
diff changeset
446
825
0779ea9f1f18 More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
447 Migrating from 0.4.x to 0.5.0
0779ea9f1f18 More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
448 =============================
0779ea9f1f18 More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
449
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
450 This has been a fairly major revision of Roundup:
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
451
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
452 1. Brand new, much more powerful, flexible, tasty and nutritious templating.
1091
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
453 Unfortunately, this means all your current templates are useless. Hopefully
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
454 the new documentation and examples will be enough to help you make the
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
455 transition. Please don't hesitate to ask on roundup-users for help (or
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
456 complete conversions if you're completely stuck)!
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
457 2. The database backed got a lot more flexible, allowing Metakit and SQL
1227
92d8e1aad2e9 added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
458 databases! The only decent SQL database implemented at present is sqlite,
92d8e1aad2e9 added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
459 but others shouldn't be a whole lot more work.
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
460 3. A brand new, highly flexible and much more robust security system including
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
461 a system of Permissions, Roles and Role assignments to users. You may now
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
462 define your own Permissions that may be checked in CGI transactions.
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
463 4. Journalling has been made less storage-hungry, so has been turned on
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
464 by default *except* for author, recipient and nosy link/unlink events. You
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
465 are advised to turn it off in your trackers too.
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
466 5. We've changed the terminology from "instance" to "tracker", to ease the
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
467 learning curve/impact for new users.
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
468 6. Because of the above changes, the tracker configuration has seen some
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
469 major changes. See below for the details.
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
470
1091
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
471 Please, **back up your database** before you start the migration process. This
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
472 is as simple as copying the "db" directory and all its contents from your
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
473 tracker to somewhere safe.
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
474
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
475
825
0779ea9f1f18 More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
476 0.5.0 Configuration
0779ea9f1f18 More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
477 -------------------
0779ea9f1f18 More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
478
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
479 First up, rename your ``instance_config.py`` file to just ``config.py``.
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
480
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
481 Then edit your tracker's ``__init__.py`` module. It'll currently look
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
482 like this::
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
483
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
484 from instance_config import *
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
485 try:
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
486 from dbinit import *
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
487 except ImportError:
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
488 pass # in installdir (probably :)
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
489 from interfaces import *
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
490
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
491 and it needs to be::
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
492
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
493 import config
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
494 from dbinit import open, init
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
495 from interfaces import Client, MailGW
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
496
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
497 Due to the new templating having a top-level ``page`` that defines links for
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
498 searching, indexes, adding items etc, the following variables are no longer
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
499 used:
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
500
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
501 - HEADER_INDEX_LINKS
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
502 - HEADER_ADD_LINKS
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
503 - HEADER_SEARCH_LINKS
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
504 - SEARCH_FILTERS
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
505 - DEFAULT_INDEX
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
506 - UNASSIGNED_INDEX
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
507 - USER_INDEX
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
508 - ISSUE_FILTER
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
509
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
510 The new security implementation will require additions to the dbinit module,
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
511 but also removes the need for the following tracker config variables:
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
512
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
513 - ANONYMOUS_ACCESS
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
514 - ANONYMOUS_REGISTER
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
515
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
516 but requires two new variables which define the Roles assigned to users who
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
517 register through the web and e-mail interfaces:
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
518
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
519 - NEW_WEB_USER_ROLES
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
520 - NEW_EMAIL_USER_ROLES
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
521
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
522 in both cases, 'User' is a good initial setting. To emulate
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
523 ``ANONYMOUS_ACCESS='deny'``, remove all "View" Permissions from the
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
524 "Anonymous" Role. To emulate ``ANONYMOUS_REGISTER='deny'``, remove the "Web
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
525 Registration" and/or the "Email Registration" Permission from the "Anonymous"
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
526 Role. See the section on customising security in the `customisation
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
527 documentation`_ for more information.
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
528
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1091
diff changeset
529 Finally, the following config variables have been renamed to make more sense:
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1091
diff changeset
530
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1091
diff changeset
531 - INSTANCE_HOME -> TRACKER_HOME
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1091
diff changeset
532 - INSTANCE_NAME -> TRACKER_NAME
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1091
diff changeset
533 - ISSUE_TRACKER_WEB -> TRACKER_WEB
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1091
diff changeset
534 - ISSUE_TRACKER_EMAIL -> TRACKER_EMAIL
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1091
diff changeset
535
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
536
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
537 0.5.0 Schema Specification
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
538 --------------------------
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
539
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
540 0.5.0 Database backend changes
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
541 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
542
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
543 Your select_db module in your tracker has changed a fair bit. Where it used
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
544 to contain::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
545
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
546 # WARNING: DO NOT EDIT THIS FILE!!!
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
547 from roundup.backends.back_anydbm import Database
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
548
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
549 it must now contain::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
550
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
551 # WARNING: DO NOT EDIT THIS FILE!!!
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
552 from roundup.backends.back_anydbm import Database, Class, FileClass, IssueClass
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
553
1051
a0c7df67dd9c Allow a page request to include a :contentonly variable.
Richard Jones <richard@users.sourceforge.net>
parents: 1034
diff changeset
554 Yes, I realise the irony of the "DO NOT EDIT THIS FILE" statement :)
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
555 Note the addition of the Class, FileClass, IssueClass imports. These are very
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
556 important, as they're going to make the next change work too. You now need to
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
557 modify the top of the dbinit module in your tracker from::
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
558
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
559 import instance_config
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
560 from roundup import roundupdb
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
561 from select_db import Database
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
562
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
563 from roundup.roundupdb import Class, FileClass
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
564
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
565 class Database(roundupdb.Database, select_db.Database):
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
566 ''' Creates a hybrid database from:
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
567 . the selected database back-end from select_db
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
568 . the roundup extensions from roundupdb
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
569 '''
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
570 pass
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
571
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
572 class IssueClass(roundupdb.IssueClass):
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
573 ''' issues need the email information
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
574 '''
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
575 pass
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
576
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
577 to::
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
578
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
579 import config
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
580 from select_db import Database, Class, FileClass, IssueClass
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
581
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
582 Yes, remove the Database and IssueClass definitions and those other imports.
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
583 They're not needed any more!
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
584
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
585 Look for places in dbinit.py where ``instance_config`` is used too, and
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
586 rename them ``config``.
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
587
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
588
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
589 0.5.0 Journalling changes
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
590 ~~~~~~~~~~~~~~~~~~~~~~~~~
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
591
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
592 Journalling has been optimised for storage. Journalling of links has been
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
593 turned back on by default. If your tracker has a large user base, you may wish
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
594 to turn off journalling of nosy list, message author and message recipient
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
595 link and unlink events. You do this by adding ``do_journal='no'`` to the Class
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
596 initialisation in your dbinit. For example, your *msg* class initialisation
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
597 probably looks like this::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
598
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
599 msg = FileClass(db, "msg",
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
600 author=Link("user"), recipients=Multilink("user"),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
601 date=Date(), summary=String(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
602 files=Multilink("file"),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
603 messageid=String(), inreplyto=String())
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
604
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
605 to turn off journalling of author and recipient link events, add
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
606 ``do_journal='no'`` to the ``author=Link("user")`` part of the statement,
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
607 like so::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
608
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
609 msg = FileClass(db, "msg",
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
610 author=Link("user", do_journal='no'),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
611 recipients=Multilink("user", do_journal='no'),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
612 date=Date(), summary=String(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
613 files=Multilink("file"),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
614 messageid=String(), inreplyto=String())
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
615
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
616 Nosy list link event journalling is actually turned off by default now. If you
1227
92d8e1aad2e9 added mention of the new "minimal" template...
Richard Jones <richard@users.sourceforge.net>
parents: 1096
diff changeset
617 want to turn it on, change to your issue class' nosy list, change its
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
618 definition from::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
619
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
620 issue = IssueClass(db, "issue",
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
621 assignedto=Link("user"), topic=Multilink("keyword"),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
622 priority=Link("priority"), status=Link("status"))
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
623
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
624 to::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
625
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
626 issue = IssueClass(db, "issue", nosy=Multilink("user", do_journal='yes'),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
627 assignedto=Link("user"), topic=Multilink("keyword"),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
628 priority=Link("priority"), status=Link("status"))
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
629
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
630 noting that your definition of the nosy Multilink will override the normal one.
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
631
1009
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
632
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
633 0.5.0 User schema changes
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
634 ~~~~~~~~~~~~~~~~~~~~~~~~~
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
635
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
636 Users have two more properties, "queries" and "roles". You'll have something
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
637 like this in your dbinit module now::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
638
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
639 user = Class(db, "user",
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
640 username=String(), password=Password(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
641 address=String(), realname=String(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
642 phone=String(), organisation=String(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
643 alternate_addresses=String())
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
644 user.setkey("username")
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
645
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
646 and you'll need to add the new properties and the new "query" class to it
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
647 like so::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
648
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
649 query = Class(db, "query",
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
650 klass=String(), name=String(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
651 url=String())
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
652 query.setkey("name")
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
653
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
654 # Note: roles is a comma-separated string of Role names
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
655 user = Class(db, "user",
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
656 username=String(), password=Password(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
657 address=String(), realname=String(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
658 phone=String(), organisation=String(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
659 alternate_addresses=String(),
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
660 queries=Multilink('query'), roles=String())
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
661 user.setkey("username")
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
662
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
663 The "queries" property is used to store off the user's favourite database
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
664 queries. The "roles" property is explained below in `0.5.0 Security
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
665 Settings`_.
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
666
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
667
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
668 0.5.0 Security Settings
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
669 ~~~~~~~~~~~~~~~~~~~~~~~
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
670
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
671 See the `security documentation`_ for an explanation of how the new security
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
672 system works. In a nutshell though, the security is handled as a four step
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
673 process:
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
674
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
675 1. Permissions are defined as having a name and optionally a hyperdb class
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
676 they're specific to,
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
677 2. Roles are defined that have one or more Permissions,
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
678 3. Users are assigned Roles in their "roles" property, and finally
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
679 4. Roundup checks that users have appropriate Permissions at appropriate times
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
680 (like editing issues).
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
681
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
682 Your tracker dbinit module's *open* function now has to define any
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
683 Permissions that are specific to your tracker, and also the assignment
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
684 of Permissions to Roles. At the moment, your open function
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
685 ends with::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
686
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
687 import detectors
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
688 detectors.init(db)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
689
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
690 return db
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
691
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
692 and what we need to do is insert some commands that will set up the security
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
693 parameters. Right above the ``import detectors`` line, you'll want to insert
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
694 these lines::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
695
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
696 #
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
697 # SECURITY SETTINGS
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
698 #
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
699 # new permissions for this schema
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
700 for cl in 'issue', 'file', 'msg', 'user':
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
701 db.security.addPermission(name="Edit", klass=cl,
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
702 description="User is allowed to edit "+cl)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
703 db.security.addPermission(name="View", klass=cl,
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
704 description="User is allowed to access "+cl)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
705
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
706 # Assign the access and edit permissions for issue, file and message
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
707 # to regular users now
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
708 for cl in 'issue', 'file', 'msg':
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
709 p = db.security.getPermission('View', cl)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
710 db.security.addPermissionToRole('User', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
711 p = db.security.getPermission('Edit', cl)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
712 db.security.addPermissionToRole('User', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
713 # and give the regular users access to the web and email interface
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
714 p = db.security.getPermission('Web Access')
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
715 db.security.addPermissionToRole('User', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
716 p = db.security.getPermission('Email Access')
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
717 db.security.addPermissionToRole('User', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
718
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
719 # May users view other user information? Comment these lines out
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
720 # if you don't want them to
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
721 p = db.security.getPermission('View', 'user')
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
722 db.security.addPermissionToRole('User', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
723
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
724 # Assign the appropriate permissions to the anonymous user's Anonymous
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
725 # Role. Choices here are:
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
726 # - Allow anonymous users to register through the web
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
727 p = db.security.getPermission('Web Registration')
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
728 db.security.addPermissionToRole('Anonymous', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
729 # - Allow anonymous (new) users to register through the email gateway
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
730 p = db.security.getPermission('Email Registration')
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
731 db.security.addPermissionToRole('Anonymous', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
732 # - Allow anonymous users access to the "issue" class of data
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
733 # Note: this also grants access to related information like files,
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
734 # messages, statuses etc that are linked to issues
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
735 #p = db.security.getPermission('View', 'issue')
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
736 #db.security.addPermissionToRole('Anonymous', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
737 # - Allow anonymous users access to edit the "issue" class of data
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
738 # Note: this also grants access to create related information like
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
739 # files and messages etc that are linked to issues
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
740 #p = db.security.getPermission('Edit', 'issue')
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
741 #db.security.addPermissionToRole('Anonymous', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
742
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
743 # oh, g'wan, let anonymous access the web interface too
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
744 p = db.security.getPermission('Web Access')
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
745 db.security.addPermissionToRole('Anonymous', p)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
746
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
747 Note in the comments there the places where you might change the permissions
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
748 to restrict users or grant users more access. If you've created additional
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
749 classes that users should be able to edit and view, then you should add them
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
750 to the "new permissions for this schema" section at the start of the security
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
751 block. Then add them to the "Assign the access and edit permissions" section
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
752 too, so people actually have the new Permission you've created.
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
753
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
754 One final change is needed that finishes off the security system's
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
755 initialisation. We need to add a call to ``db.post_init()`` at the end of the
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
756 dbinit open() function. Add it like this::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
757
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
758 import detectors
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
759 detectors.init(db)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
760
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
761 # schema is set up - run any post-initialisation
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
762 db.post_init()
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
763 return db
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
764
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
765 You may verify the setup of Permissions and Roles using the new
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
766 "``roundup-admin security``" command.
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
767
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
768
1009
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
769 0.5.0 User changes
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
770 ~~~~~~~~~~~~~~~~~~
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
771
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
772 To support all those schema changes, you'll need to massage your user database
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
773 a little too, to:
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
774
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
775 1. make sure there's an "anonymous" user - this user is mandatory now and is
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
776 the one that unknown users are logged in as.
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
777 2. make sure all users have at least one Role.
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
778
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
779 If you don't have the "anonymous" user, create it now with the command::
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
780
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
781 roundup-admin create user username=anonymous roles=Anonymous
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
782
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
783 making sure the capitalisation is the same as above. Once you've done that,
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
784 you'll need to set the roles property on all users to a reasonable default.
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
785 The admin user should get "Admin", the anonymous user "Anonymous"
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
786 and all other users "User". The ``fixroles.py`` script in the tools directory
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
787 will do this. Run it like so (where python is your python 2+ binary)::
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
788
1271
7733d5b96ef6 docco fix
Richard Jones <richard@users.sourceforge.net>
parents: 1227
diff changeset
789 python tools/fixroles.py -i <tracker home> fixroles
1009
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
790
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
791
fc55426544b5 more upgrading docco and a tool to fix roles
Richard Jones <richard@users.sourceforge.net>
parents: 1008
diff changeset
792
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
793 0.5.0 CGI interface changes
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
794 ---------------------------
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
795
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
796 The CGI interface code was completely reorganised and largely rewritten. The
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
797 end result is that this section of your tracker interfaces module will need
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
798 changing from::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
799
1308
bd71c43f0911 fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents: 1271
diff changeset
800 from roundup import cgi_client, mailgw
bd71c43f0911 fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents: 1271
diff changeset
801 from roundup.i18n import _
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
802
1308
bd71c43f0911 fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents: 1271
diff changeset
803 class Client(cgi_client.Client):
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
804 ''' derives basic CGI implementation from the standard module,
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
805 with any specific extensions
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
806 '''
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
807 pass
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
808
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
809 to::
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
810
1308
bd71c43f0911 fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents: 1271
diff changeset
811 from roundup import mailgw
bd71c43f0911 fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents: 1271
diff changeset
812 from roundup.cgi import client
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
813
1308
bd71c43f0911 fixed upgrading doc to have CGI changes in the correct order
Richard Jones <richard@users.sourceforge.net>
parents: 1271
diff changeset
814 class Client(client.Client):
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
815 ''' derives basic CGI implementation from the standard module,
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
816 with any specific extensions
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
817 '''
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
818 pass
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
819
1034
6afef8529d6c mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents: 1009
diff changeset
820 You will also need to install the new version of roundup.cgi from the source
6afef8529d6c mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents: 1009
diff changeset
821 cgi-bin directory if you're using it.
6afef8529d6c mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents: 1009
diff changeset
822
6afef8529d6c mention cgi script update
Richard Jones <richard@users.sourceforge.net>
parents: 1009
diff changeset
823
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
824 0.5.0 HTML templating
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
825 ---------------------
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
826
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
827 You'll want to make a backup of your current tracker html directory. You
1091
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
828 should then copy the html directory from the Roundup source "classic" template
d870139aeb5c more doc
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
829 and modify it according to your local schema changes.
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
830
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
831 If you need help with the new templating system, please ask questions on the
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
832 roundup-users mailing list (available through the roundup project page on
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
833 sourceforge, http://roundup.sf.net/)
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
834
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
835
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
836 0.5.0 Detectors
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
837 ---------------
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
838
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
839 The nosy reactor has been updated to handle the tracker not having an
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
840 "assignedto" property on issues. You may want to copy it into your tracker's
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
841 detectors directory. Chances are you've already fixed it though :)
825
0779ea9f1f18 More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
842
0779ea9f1f18 More indexer work:
Richard Jones <richard@users.sourceforge.net>
parents: 798
diff changeset
843
782
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
844 Migrating from 0.4.1 to 0.4.2
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
845 =============================
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
846
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
847 0.4.2 Configuration
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
848 -------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
849 The USER_INDEX definition introduced in 0.4.1 was too restrictive in its
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
850 allowing replacement of 'assignedto' with the user's userid. Users must change
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
851 the None value of 'assignedto' to 'CURRENT USER' (the string, in quotes) for
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
852 the replacement behaviour to occur now.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
853
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
854 The new configuration variables are:
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
855
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
856 - EMAIL_KEEP_QUOTED_TEXT
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
857 - EMAIL_LEAVE_BODY_UNCHANGED
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
858 - ADD_RECIPIENTS_TO_NOSY
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
859
798
faf164ab8ed9 Docco changes.
Richard Jones <richard@users.sourceforge.net>
parents: 782
diff changeset
860 See the sample configuration files in::
782
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
861
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
862 <roundup source>/roundup/templates/classic/instance_config.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
863
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
864 and::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
865
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
866 <roundup source>/roundup/templates/extended/instance_config.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
867
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
868 and the `customisation documentation`_ for information on how they're used.
782
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
869
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
870
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
871 0.4.2 Changes to detectors
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
872 --------------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
873 You will need to copy the detectors from the distribution into your instance
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
874 home "detectors" directory. If you used the classic schema, the detectors
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
875 are in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
876
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
877 <roundup source>/roundup/templates/classic/detectors/
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
878
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
879 If you used the extended schema, the detectors are in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
880
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
881 <roundup source>/roundup/templates/extended/detectors/
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
882
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
883 The change means that schema-specific code has been removed from the
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
884 mail gateway and cgi interface and made into auditors:
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
885
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
886 - nosyreactor.py has now got an updatenosy auditor which updates the nosy
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
887 list with author, recipient and assignedto information.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
888 - statusauditor.py makes the unread or resolved -> chatting changes and
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
889 presets the status of an issue to unread.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
890
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
891 There's also a bug or two fixed in the nosyreactor code.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
892
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
893 0.4.2 HTML templating changes
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
894 -----------------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
895 The link() htmltemplate function now has a "showid" option for links and
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 1051
diff changeset
896 multilinks. When true, it only displays the linked item id as the anchor
782
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
897 text. The link value is displayed as a tooltip using the title anchor
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
898 attribute. To use in eg. the superseder field, have something like this::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
899
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
900 <td>
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
901 <display call="field('superseder', showid=1)">
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
902 <display call="classhelp('issue', 'id,title', label='list', width=500)">
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
903 <property name="superseder">
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
904 <br>View: <display call="link('superseder', showid=1)">
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
905 </property>
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
906 </td>
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
907
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
908 The stylesheets have been cleaned up too. You may want to use the newer
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
909 versions in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
910
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
911 <roundup source>/roundup/templates/<template>/html/default.css
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
912
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
913
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
914
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
915 Migrating from 0.4.0 to 0.4.1
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
916 =============================
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
917
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
918 0.4.1 Files storage
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
919 -------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
920
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
921 Messages and files from newly created issues will be put into subdierectories
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
922 in thousands e.g. msg123 will be put into files/msg/0/msg123, file2003
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
923 will go into files/file/2/file2003. Previous messages are still found, but
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
924 could be put into this structure.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
925
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
926 0.4.1 Configuration
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
927 -------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
928
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
929 To allow more fine-grained access control, the variable used to check
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
930 permission to auto-register users in the mail gateway is now called
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
931 ANONYMOUS_REGISTER_MAIL rather than overloading ANONYMOUS_REGISTER. If the
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
932 variable doesn't exist, then ANONYMOUS_REGISTER is tested as before.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
933
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
934 Configuring the links in the web header is now easier too. The following
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
935 variables have been added to the classic instance_config.py::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
936
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
937 HEADER_INDEX_LINKS - defines the "index" links to be made available
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
938 HEADER_ADD_LINKS - defines the "add" links
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
939 DEFAULT_INDEX - specifies the index view for DEFAULT
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
940 UNASSIGNED_INDEX - specifies the index view for UNASSIGNED
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
941 USER_INDEX - specifies the index view for USER
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
942
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
943 See the <roundup source>/roundup/templates/classic/instance_config.py for more
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
944 information - including how the variables are to be set up. Most users will
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
945 just be able to copy the variables from the source to their instance home. If
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
946 you've modified the header by changing the source of the interfaces.py file in
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
947 the instance home, you'll need to remove that customisation and move it into
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
948 the appropriate variables in instance_config.py.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
949
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
950 The extended schema has similar variables added too - see the source for more
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
951 info.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
952
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
953 0.4.1 Alternate E-Mail Addresses
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
954 --------------------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
955
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
956 If you add the property "alternate_addresses" to your user class, your users
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
957 will be able to register alternate email addresses that they may use to
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
958 communicate with roundup as. All email from roundup will continue to be sent
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
959 to their primary address.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
960
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
961 If you have not edited the dbinit.py file in your instance home directory,
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
962 you may simply copy the new dbinit.py file from the core code. If you used
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
963 the classic schema, the interfaces file is in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
964
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
965 <roundup source>/roundup/templates/classic/dbinit.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
966
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
967 If you used the extended schema, the file is in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
968
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
969 <roundup source>/roundup/templates/extended/dbinit.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
970
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
971 If you have modified your dbinit.py file, you need to edit the dbinit.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
972 file in your instance home directory. Find the lines which define the user
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
973 class::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
974
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
975 user = Class(db, "msg",
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
976 username=String(), password=Password(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
977 address=String(), realname=String(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
978 phone=String(), organisation=String(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
979 alternate_addresses=String())
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
980
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
981 You will also want to add the property to the user's details page. The
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
982 template for this is the "user.item" file in your instance home "html"
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
983 directory. Similar to above, you may copy the file from the roundup source if
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
984 you haven't modified it. Otherwise, add the following to the template::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
985
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
986 <display call="multiline('alternate_addresses')">
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
987
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
988 with appropriate labelling etc. See the standard template for an idea.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
989
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
990
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
991
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
992 Migrating from 0.3.x to 0.4.0
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
993 =============================
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
994
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
995 0.4.0 Message-ID and In-Reply-To addition
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
996 -----------------------------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
997 0.4.0 adds the tracking of messages by message-id and allows threading
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
998 using in-reply-to. Most e-mail clients support threading using this
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
999 feature, and we hope to add support for it to the web gateway. If you
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1000 have not edited the dbinit.py file in your instance home directory, you may
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1001 simply copy the new dbinit.py file from the core code. If you used the
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1002 classic schema, the interfaces file is in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1003
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1004 <roundup source>/roundup/templates/classic/dbinit.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1005
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1006 If you used the extended schema, the file is in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1007
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1008 <roundup source>/roundup/templates/extended/dbinit.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1009
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1010 If you have modified your dbinit.py file, you need to edit the dbinit.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1011 file in your instance home directory. Find the lines which define the msg
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1012 class::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1013
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1014 msg = FileClass(db, "msg",
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1015 author=Link("user"), recipients=Multilink("user"),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1016 date=Date(), summary=String(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1017 files=Multilink("file"))
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1018
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1019 and add the messageid and inreplyto properties like so::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1020
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1021 msg = FileClass(db, "msg",
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1022 author=Link("user"), recipients=Multilink("user"),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1023 date=Date(), summary=String(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1024 files=Multilink("file"),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1025 messageid=String(), inreplyto=String())
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1026
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1027 Also, configuration is being cleaned up. This means that your dbinit.py will
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1028 also need to be changed in the open function. If you haven't changed your
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1029 dbinit.py, the above copy will be enough. If you have, you'll need to change
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1030 the line (round line 50)::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1031
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1032 db = Database(instance_config.DATABASE, name)
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1033
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1034 to::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1035
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1036 db = Database(instance_config, name)
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1037
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1038
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1039 0.4.0 Configuration
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1040 --------------------
1096
fa7df238e2d4 More cleaning up of configuration, and the "instance" -> "tracker" renaming.
Richard Jones <richard@users.sourceforge.net>
parents: 1091
diff changeset
1041 ``TRACKER_NAME`` and ``EMAIL_SIGNATURE_POSITION`` have been added to the
782
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1042 instance_config.py. The simplest solution is to copy the default values
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1043 from template in the core source.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1044
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1045 The mail gateway now checks ``ANONYMOUS_REGISTER`` to see if unknown users
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1046 are to be automatically registered with the tracker. If it is set to "deny"
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1047 then unknown users will not have access. If it is set to "allow" they will be
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1048 automatically registered with the tracker.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1049
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1050
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1051 0.4.0 CGI script roundup.cgi
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1052 ----------------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1053 The CGI script has been updated with some features and a bugfix, so you should
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1054 copy it from the roundup cgi-bin source directory again. Make sure you update
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1055 the ROUNDUP_INSTANCE_HOMES after the copy.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1056
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1057
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1058 0.4.0 Nosy reactor
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1059 ------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1060 The nosy reactor has also changed - copy the nosyreactor.py file from the core
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1061 source::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1062
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1063 <roundup source>/roundup/templates/<template>/detectors/nosyreactor.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1064
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1065 to your instance home "detectors" directory.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1066
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1067
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1068 0.4.0 HTML templating
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1069 ---------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1070 The field() function was incorrectly implemented - links and multilinks now
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1071 display as text fields when rendered using field(). To display a menu (drop-
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1072 down or select box) you need to use the menu() function.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1073
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1074
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1075
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1076 Migrating from 0.2.x to 0.3.x
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1077 =============================
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1078
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1079 0.3.x Cookie Authentication changes
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1080 -----------------------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1081 0.3.0 introduces cookie authentication - you will need to copy the
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1082 interfaces.py file from the roundup source to your instance home to enable
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1083 authentication. If you used the classic schema, the interfaces file is in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1084
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1085 <roundup source>/roundup/templates/classic/interfaces.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1086
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1087 If you used the extended schema, the file is in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1088
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1089 <roundup source>/roundup/templates/extended/interfaces.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1090
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1091 If you have modified your interfaces.Client class, you will need to take
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1092 note of the login/logout functionality provided in roundup.cgi_client.Client
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1093 (classic schema) or roundup.cgi_client.ExtendedClient (extended schema) and
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1094 modify your instance code apropriately.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1095
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1096
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1097 0.3.x Password encoding
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1098 -----------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1099 This release also introduces encoding of passwords in the database. If you
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1100 have not edited the dbinit.py file in your instance home directory, you may
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1101 simply copy the new dbinit.py file from the core code. If you used the
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1102 classic schema, the interfaces file is in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1103
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1104 <roundup source>/roundup/templates/classic/dbinit.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1105
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1106 If you used the extended schema, the file is in::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1107
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1108 <roundup source>/roundup/templates/extended/dbinit.py
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1109
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1110
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1111 If you have modified your dbinit.py file, you may use encoded passwords:
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1112
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1113 1. Edit the dbinit.py file in your instance home directory
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1114 a. At the first code line of the open() function::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1115
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1116 from roundup.hyperdb import String, Date, Link, Multilink
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1117
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1118 alter to include Password, as so::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1119
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1120 from roundup.hyperdb import String, Password, Date, Link, Multilink
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1121
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1122 b. Where the password property is defined (around line 66)::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1123
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1124 user = Class(db, "user",
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1125 username=String(), password=String(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1126 address=String(), realname=String(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1127 phone=String(), organisation=String())
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1128 user.setkey("username")
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1129
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1130 alter the "password=String()" to "password=Password()"::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1131
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1132 user = Class(db, "user",
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1133 username=String(), password=Password(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1134 address=String(), realname=String(),
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1135 phone=String(), organisation=String())
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1136 user.setkey("username")
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1137
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1138 2. Any existing passwords in the database will remain cleartext until they
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1139 are edited. It is recommended that at a minimum the admin password be
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1140 changed immediately::
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1141
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1142 roundup-admin -i <instance home> set user1 password=<new password>
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1143
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1144
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1145 0.3.x Configuration
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1146 -------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1147 FILTER_POSITION, ANONYMOUS_ACCESS, ANONYMOUS_REGISTER have been added to
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1148 the instance_config.py. Simplest solution is to copy the default values from
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1149 template in the core source.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1150
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1151 MESSAGES_TO_AUTHOR has been added to the IssueClass in dbinit.py. Set to 'yes'
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1152 to send nosy messages to the author. Default behaviour is to not send nosy
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1153 messages to the author. You will need to add MESSAGES_TO_AUTHOR to your
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1154 dbinit.py in your instance home.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1155
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1156
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1157 0.3.x CGI script roundup.cgi
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1158 ----------------------------
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1159 There have been some structural changes to the roundup.cgi script - you will
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1160 need to install it again from the cgi-bin directory of the source
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1161 distribution. Make sure you update the ROUNDUP_INSTANCE_HOMES after the
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1162 copy.
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1163
6f6eb43d9d86 Moved the MIGRATION text in with the rest of the docco, fixed up for 0.4.2
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1164
1008
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
1165 .. _`customisation documentation`: customizing.html
10ed4791f969 Wrote most of the upgrading documentation (please read!)
Richard Jones <richard@users.sourceforge.net>
parents: 979
diff changeset
1166 .. _`security documentation`: security.html
2409
Richard Jones <richard@users.sourceforge.net>
parents: 2374
diff changeset
1167 .. _`administration guide`: admin_guide.html

Roundup Issue Tracker: http://roundup-tracker.org/