Mercurial > p > roundup > code

annotate doc/upgrading-history.txt @ 8064:d6b447de4f59

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: set up for release documentation. Make changes to publish security.html with CVE announcements referring to the sections in upgrading.html rather than CVE.html. Remove templates.zip as part of html build in Makefile. Also update doc for using CVE.html.
author John Rouillard <rouilj@ieee.org>
date Tue, 09 Jul 2024 09:34:13 -0400
parents 3f2d743824e9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1 ===============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
2 Upgrading versions before 1.5.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
3 ===============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
4
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
5 .. note::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
6 If you are upgrading from a version of Roundup that is newer than
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
7 1.5.0, use the version steps in the `main upgrading document`_.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
8
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
9 Please read each section carefully and edit your tracker home files
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
10 accordingly. Note that there is information about upgrade procedures in the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
11 `administration guide`_ in the `Software Upgrade`_ section.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
12
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
13 If a specific version transition isn't mentioned here (eg. 0.6.7 to 0.6.8)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
14 then you don't need to do anything. If you're upgrading from 0.5.6 to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
15 0.6.8 though, you'll need to check the "0.5 to 0.6" and "0.6.x to 0.6.3"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
16 steps.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
17
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
18 General steps:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
19
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
20 1. Make note of your current Roundup version.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
21 2. Take your Roundup installation offline (web, email,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
22 cron scripts, roundup-admin etc.)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
23 3. Backup your Roundup instance
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
24 4. Install a new version of Roundup
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
25 5. Make version specific changes as described below for
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
26 each version transition. If you are starting at 1.5.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
27 and installing to 2.3, you need to make the changes for **all**
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
28 versions starting at 1.5 and ending at 2.3. E.G.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
29 1.5.0 -> 1.5.1, 1.5.1 -> 1.6.0, ..., 2.1.0 -> 2.2.0,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
30 2.2.0 -> 2.3.0.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
31 6. Run ``roundup-admin -i <tracker_home> migrate`` for
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
32 **all** your trackers. This will update the database if
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
33 it is required.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
34 7. Bring your Roundup instance back online
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
35 8. Test
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
36
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
37 **IMPORTANT** The v1.5.x releases of Roundup were the last to support
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
38 Python v2.5 and v2.6. Starting with the v1.6 releases of Roundup
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
39 Python version 2.7 that is newer than 2.7.2 is required to run
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
40 Roundup. Starting with Roundup version 2.0.0 we also support Python 3
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
41 versions newer than 3.4.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
42
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
43 Contents:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
44
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
45 .. contents::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
46 :local:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
47
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
48 .. index:: Upgrading; 1.4.20 to 1.4.21
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
49
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
50 Migrating from 1.4.20 to 1.4.21
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
51 ===============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
52
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
53 The ``_generic.calendar.html`` page of the instance has been updated to include
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
54 ``<meta name="robots" content="noindex, nofollow" />``. This prevents
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
55 robots to follow all the links in the calendar. If you haven't modified the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
56 page on your local instance, you can simply replace it with the one in
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
57 ``share/roundup/templates/classic/html/_generic.calendar.html``; if you did,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
58 you can add the tag manually. See issue2550765 and changeset a099ff2ceff3.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
59
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
60 If you are using the xml-rpc interface, there is a change
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
61 in accessing it. You can not send text/xml data to any
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
62 roundup url and get a response, you must use the /xmlrpc
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
63 url. For example, if you used to send your xmlrpc request to:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
64
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
65 \http://myroundup.com/roundup
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
66
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
67 you need to change the url to read:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
68
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
69 \http://myroundup.com/roundup/xmlrpc
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
70
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
71 to invoke the xmlrpc handler. This allows us to send xml
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
72 data to roundup for other handlers (e.g. REST, SOAP ...)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
73 in the future.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
74
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
75
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
76 .. index:: Upgrading; 1.4.19 to 1.4.20
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
77
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
78 Migrating from 1.4.19 to 1.4.20
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
79 ===============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
80
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
81 Roundup used to allow certain HTML-Tags in OK- and Error-messages. Since
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
82 these messages are passed via the URL (due to roundup redirecting after
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
83 an edit), we did have security-issues (see issue2550724).
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
84
7499
a072331c843b Change customizing to customising in all variants.
John Rouillard <rouilj@ieee.org>
parents: 7458
diff changeset
85 If you have customised the OK or Error messages in your
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
86 roundup-installation and you were using features like bold or italic
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
87 in the message, you will have to do without this highlighting and
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
88 remove HTML tags from messages.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
89
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
90 If you were using <br> tags for multi-line messages, you now should use
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
91 newlines instead, these will be replaced with <br/> during formatting.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
92
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
93 Note that the previous implementation also allowed links inside
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
94 messages. Since these links could be set by an attacker, no links in
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
95 roundup messages are supported anymore. This does *not* affect the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
96 "clear this message" link in OK-messages as it is generated by the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
97 template and is not part of the OK-message.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
98
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
99 If you have not modified any roundup messages, you need not do anything,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
100 the templates shipped with roundup did not use HTML tags in messages for
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
101 highlighting.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
102
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
103
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
104 .. index:: Upgrading; 1.4.17 to 1.4.18
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
105
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
106 Migrating from 1.4.17 to 1.4.18
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
107 ===============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
108
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
109 There was a bug in 1.4.17 where files were unlinked from issues if a
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
110 mail without attachment was received via the mail interface. The
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
111 following script will list likely issues being affected by the bug.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
112 The date in the script is the date of the 1.4.17 release. If you have
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
113 installed 1.4.17 later than this date, you can change the date
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
114 appropriately to your installation date. Run the script in the directory
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
115 of your tracker::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
116
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
117 #!/usr/bin/python
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
118 import os
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
119 from roundup import instance
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
120 from roundup.date import Date
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
121 dir = os.getcwd ()
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
122 tracker = instance.open (dir)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
123 db = tracker.open ('admin')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
124 # you may want to change this to your install date to find less candidates
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
125 last_release = Date('2011-05-13')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
126 affected = {}
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
127 for i in db.issue.getnodeids():
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
128 for j in db.issue.history(i):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
129 if i in affected:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
130 break
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
131 if j[1] < last_release or j[3] != 'set' or 'files' not in j[4]:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
132 continue
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
133 for op, p in j[4]['files']:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
134 if op == '-':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
135 affected [i] = 1
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
136 break
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
137 print(', '.join(sorted(affected.keys())))
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
138
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
139 To find out which files where attached before you can look in the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
140 history of the affected issue. For fixing issues you can re-attach the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
141 files in question using the "set" command of roundup-admin, e.g., if the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
142 list of files attached to an issue should be files 5, 17, 23 for issue42
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
143 you will set this using
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
144
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
145 roundup-admin -i /path/to/your/tracker set issue42 files=5,17,23
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
146
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
147 .. index:: Upgrading; 1.4.x to 1.4.17
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
148
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
149 Migrating from 1.4.x to 1.4.17
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
150 ==============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
151
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
152 There is a new config-option `migrate_passwords` in section `web` to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
153 auto-migrate passwords at web-login time to a more secure storage
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
154 scheme. Default for the new option is "yes" so if you don't want that
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
155 passwords are auto-migrated to a more secure password scheme on user
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
156 login, set this to "no" before running your tracker(s) after the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
157 upgrade.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
158
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
159 The standalone roundup-server now defaults to listening on localhost (no
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
160 longer on all network interfaces). This will not affect you if you're
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
161 already using a configuration file for roundup-server. If you are using
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
162 an empty setting for the `host` parameter in the config-file you should
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
163 explicitly put 0.0.0.0 there as the use of an empty string to specify
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
164 listening to all interfaces is deprecated and will go away in a future
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
165 version. If you are starting the server without a configuration file
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
166 and want to explicitly listen to all network interface, you should
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
167 specify the -n option with the address `0.0.0.0`.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
168
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
169 .. _new search permissions for query in 1.4.17:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
170
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
171 Searching now requires either read-permission without a check method, or
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
172 you will have to add a "Search" permission for a class or a list of
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
173 properties for a class (if you want to allow searching). For the classic
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
174 template (or other templates derived from it) you want to add the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
175 following lines to your `schema.py` file::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
176
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
177 p = db.security.addPermission(name='Search', klass='query')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
178 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
179
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
180 This is needed, because for the `query` class users may view only their
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
181 own queries (or public queries). This is implemented with a `check`
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
182 method, therefore the default search permissions will not allow
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
183 searching and you'll have to add an explicit search permission.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
184 If you have modified your schema, you can check if you're missing any
7504
1a912887d704 Clarify meaning of 'tracker directory' in upgrading doc.
John Rouillard <rouilj@ieee.org>
parents: 7499
diff changeset
185 search permissions with the following script, run it in your :term:`tracker
1a912887d704 Clarify meaning of 'tracker directory' in upgrading doc.
John Rouillard <rouilj@ieee.org>
parents: 7499
diff changeset
186 home` directory, it will list for each Class and Property the roles that may
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
187 search for this property::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
188
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
189 #!/usr/bin/python
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
190 from __future__ import print_function
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
191 import os
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
192 from roundup import instance
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
193
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
194 tracker = instance.open(os.getcwd ())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
195 db = tracker.open('admin')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
196
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
197 for cl in sorted(db.getclasses()):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
198 print("Class:", cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
199 for p in sorted(db.getclass(cl).getprops(protected=True).keys()):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
200 print(" Property:", p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
201 roles = []
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
202 for role in sorted(db.security.role.keys()):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
203 if db.security.roleHasSearchPermission(cl,p,role):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
204 roles.append(role)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
205 print(" roles may search:", ', '.join(roles))
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
206
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
207
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
208 .. index:: Upgrading; 1.4.x to 1.4.12
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
209
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
210 Migrating from 1.4.x to 1.4.12
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
211 ==============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
212
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
213 Item creation now checks the "Create" permission instead of the "Edit"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
214 permission for individual properties. If you have modified your tracker
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
215 permissions from the default distribution, you should check that
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
216 "Create" permissions exist for all properties you want users to be able
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
217 to create.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
218
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
219
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
220 Fixing some potential security holes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
221 ------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
222
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
223 Enhanced checking was added to the user registration auditor. If you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
224 run a public tracker you should update your tracker's
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
225 ``detectors/userauditor.py`` using the new code from
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
226 ``share/roundup/templates/classic/detectors/userauditor.py``. In most
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
227 cases you may just copy the file over, but if you've made changes to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
228 the auditor in your tracker then you'll need to manually integrate
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
229 the new code.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
230
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
231 Some HTML templates were found to have formatting security problems:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
232
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
233 ``html/page.html``::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
234
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
235 -tal:replace="request/user/username">username</span></b><br>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
236 +tal:replace="python:request.user.username.plain(escape=1)">username</span></b><br>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
237
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
238 ``html/_generic.help-list.html``::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
239
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
240 -tal:content="structure python:item[prop]"></label>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
241 +tal:content="python:item[prop]"></label>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
242
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
243 The lines marked "+" should be added and lines marked "-" should be
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
244 deleted (minus the "+"/"-" signs).
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
245
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
246
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
247 Some HTML interface tweaks
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
248 --------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
249
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
250 You may wish to copy the ``user_utils.js`` and ``style.css` files from the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
251 source distribution ``share/roundup/templates/classic/html/`` directory to the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
252 ``html`` directory of your trackers as it includes a small improvement.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
253
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
254 If you have made local changes to those files you'll need to manually work
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
255 the differences in to your versions or ignore the changes.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
256
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
257
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
258 .. index:: Upgrading; 1.4.x to 1.4.11
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
259
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
260 Migrating from 1.4.x to 1.4.11
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
261 ==============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
262
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
263 Close potential security hole
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
264 -----------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
265
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
266 If your tracker has untrusted users you should examine its ``schema.py``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
267 file and look for the section granting the "Edit" permission to your users.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
268 This should look something like::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
269
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
270 p = db.security.addPermission(name='Edit', klass='user', check=own_record,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
271 description="User is allowed to edit their own user details")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
272
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
273 and should be modified to restrict the list of properties they are allowed
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
274 to edit by adding the ``properties=`` section like::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
275
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
276 p = db.security.addPermission(name='Edit', klass='user', check=own_record,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
277 properties=('username', 'password', 'address', 'realname', 'phone',
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
278 'organisation', 'alternate_addresses', 'queries', 'timezone'),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
279 description="User is allowed to edit their own user details")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
280
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
281 Most importantly the "roles" property should not be editable - thus not
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
282 appear in that list of properties.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
283
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
284
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
285 Grant the "Register" permission to the Anonymous role
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
286 -----------------------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
287
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
288 A separate "Register" permission has been introduced to allow
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
289 anonymous users to register. This means you will need to add the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
290 following to your tracker's ``schema.py`` to add the permission and
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
291 assign it to the Anonymous role (replacing any previously assigned
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
292 "Create user" permission for the Anonymous role)::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
293
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
294 +db.security.addPermission(name='Register', klass='user',
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
295 + description='User is allowed to register new user')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
296
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
297 # Assign the appropriate permissions to the anonymous user's Anonymous
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
298 # Role. Choices here are:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
299 # - Allow anonymous users to register
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
300 -db.security.addPermissionToRole('Anonymous', 'Create', 'user')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
301 +db.security.addPermissionToRole('Anonymous', 'Register', 'user')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
302
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
303 The lines marked "+" should be added and lines marked "-" should be
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
304 deleted (minus the "+"/"-" signs).
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
305
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
306 You should also modify the ``html/page.html`` template to change the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
307 permission tested there::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
308
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
309 -tal:condition="python:request.user.hasPermission('Create', 'user')"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
310 +tal:condition="python:request.user.hasPermission('Register', 'user')"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
311
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
312
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
313 Generic class editor may now restore retired items
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
314 --------------------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
315
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
316 The instructions for doing so won't be present in your tracker unless you copy
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
317 the ``_generic.index.html`` template from the roundup distribution in
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
318 ``share/roundup/templates/classic/html`` to your tracker's ``html`` directory.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
319
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
320
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
321 .. index:: Upgrading; 1.4.x to 1.4.9
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
322
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
323 Migrating from 1.4.x to 1.4.9
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
324 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
325
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
326 Customized MailGW Class
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
327 -----------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
328
7499
a072331c843b Change customizing to customising in all variants.
John Rouillard <rouilj@ieee.org>
parents: 7458
diff changeset
329 If you have customised the MailGW class in your tracker: The new MailGW
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
330 class opens the database for each message in the method handle_message
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
331 (instance.open) instead of passing the opened database as a parameter to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
332 the MailGW constructor. The old handle_message has been renamed to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
333 _handle_message. The new method opens the database and wraps the call to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
334 the old method into a try/finally.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
335
7499
a072331c843b Change customizing to customising in all variants.
John Rouillard <rouilj@ieee.org>
parents: 7458
diff changeset
336 Your customised MailGW class needs to mirror this behavior.
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
337
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
338 Fix the "remove" button in issue files and messages lists
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
339 ---------------------------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
340
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
341 The "remove" button(s) in the issue messages list needs to be altered. Find
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
342 the following in your tracker's ``html/issue.item.html`` template::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
343
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
344 <td>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
345 <form style="padding:0" tal:condition="context/is_edit_ok"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
346 tal:attributes="action string:issue${context/id}">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
347 <input type="hidden" name="@remove@files" tal:attributes="value file/id">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
348
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
349 and add ``method="POST"`` as shown below::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
350
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
351 <td>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
352 <form style="padding:0" method="POST" tal:condition="context/is_edit_ok"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
353 tal:attributes="action string:issue${context/id}">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
354 <input type="hidden" name="@remove@files" tal:attributes="value file/id">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
355
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
356 Then also find::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
357
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
358 <td>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
359 <form style="padding:0" tal:condition="context/is_edit_ok"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
360 tal:attributes="action string:issue${context/id}">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
361 <input type="hidden" name="@remove@messages" tal:attributes="value msg/id">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
362
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
363 and add ``method="POST"`` as shown below::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
364
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
365 <td>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
366 <form style="padding:0" method="POST" tal:condition="context/is_edit_ok"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
367 tal:attributes="action string:issue${context/id}">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
368 <input type="hidden" name="@remove@messages" tal:attributes="value msg/id">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
369
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
370
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
371 Fixing the "retire" button in user management list
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
372 --------------------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
373
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
374 Some previous versions of this upgrading document missed ``method="POST"``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
375 in the change to the "retire" link in the user management list
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
376 in section `Migrating from 1.4.x to 1.4.7`_.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
377 Make sure the change is done as listed below in this document.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
378
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
379
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
380 .. index:: Upgrading; 1.4.x to 1.4.7
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
381
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
382 Migrating from 1.4.x to 1.4.7
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
383 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
384
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
385 Several security issues were addressed in this release. Some aspects of your
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
386 trackers may no longer function depending on your local customisations. Core
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
387 functionality that will need to be modified:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
388
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
389 Grant the "retire" permission to users for their queries
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
390 --------------------------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
391
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
392 Users will no longer be able to retire their own queries. To remedy this you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
393 will need to add the following to your tracker's ``schema.py`` just under the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
394 line that grants them permission to edit their own queries::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
395
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
396 p = db.security.addPermission(name='Edit', klass='query', check=edit_query,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
397 description="User is allowed to edit their queries")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
398 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
399 + p = db.security.addPermission(name='Retire', klass='query', check=edit_query,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
400 + description="User is allowed to retire their queries")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
401 + db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
402 p = db.security.addPermission(name='Create', klass='query',
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
403 description="User is allowed to create queries")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
404 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
405
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
406 The lines marked "+" should be added, minus the "+" sign.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
407
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
408
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
409 Fix the "retire" link in the users list for admin users
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
410 -------------------------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
411
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
412 The "retire" link found in the file ``html/user.index.html``::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
413
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
414 <td tal:condition="context/is_edit_ok">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
415 <a tal:attributes="href string:user${user/id}?@action=retire&@template=index"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
416 i18n:translate="">retire</a>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
417
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
418 Should be replaced with::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
419
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
420 <td tal:condition="context/is_retire_ok">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
421 <form style="padding:0" method="POST"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
422 tal:attributes="action string:user${user/id}">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
423 <input type="hidden" name="@template" value="index">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
424 <input type="hidden" name="@action" value="retire">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
425 <input type="submit" value="retire" i18n:attributes="value">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
426 </form>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
427
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
428
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
429 Fix for Python 2.6+ users
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
430 -------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
431
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
432 If you use Python 2.6 you should edit your tracker's
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
433 ``detectors/nosyreaction.py`` file to change::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
434
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
435 import sets
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
436
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
437 at the top to::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
438
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
439 from roundup.anypy.sets_ import set
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
440
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
441 and then all instances of ``sets.Set()`` to ``set()`` in the later code.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
442
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
443
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
444
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
445 Trackers currently allowing HTML file uploading
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
446 -----------------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
447
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
448 Trackers which wish to continue to allow uploading of HTML content against issues
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
449 will need to set a new configuration variable in the ``[web]`` section of the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
450 tracker's ``config.ini`` file:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
451
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
452 # Setting this option enables Roundup to serve uploaded HTML
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
453 # file content *as HTML*. This is a potential security risk
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
454 # and is therefore disabled by default. Set to 'yes' if you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
455 # trust *all* users uploading content to your tracker.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
456 # Allowed values: yes, no
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
457 # Default: no
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
458 allow_html_file = no
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
459
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
460
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
461
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
462 .. index:: Upgrading; 1.4.2 to 1.4.3
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
463
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
464 Migrating from 1.4.2 to 1.4.3
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
465 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
466
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
467 If you are using the MySQL backend you will need to replace some indexes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
468 that may have been created by version 1.4.2.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
469
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
470 You should to access your MySQL database directly and remove any indexes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
471 with a name ending in "_key_retired_idx". You should then re-add them with
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
472 the same spec except the key column name needs a size. So an index on
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
473 "_user (__retired, _name)" should become "_user (__retired, _name(255))".
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
474
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
475
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
476 .. index:: Upgrading; 1.4.x to 1.4.2
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
477
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
478 Migrating from 1.4.x to 1.4.2
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
479 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
480
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
481 .. index:: roundup-admin; migrate subcommand
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
482
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
483 You should run the "roundup-admin migrate" command for your tracker once
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
484 you've installed the latest codebase.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
485
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
486 Do this before you use the web, command-line or mail interface and before
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
487 any users access the tracker.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
488
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
489 This command will respond with either "Tracker updated" (if you've not
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
490 previously run it on an RDBMS backend) or "No migration action required"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
491 (if you have run it, or have used another interface to the tracker,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
492 or are using anydbm).
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
493
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
494 It's safe to run this even if it's not required, so just get into the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
495 habit.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
496
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
497 .. index:: Upgrading; 1.3.3 to 1.4.0
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
498
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
499 Migrating from 1.3.3 to 1.4.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
500 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
501
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
502 Value of the "refwd_re" tracker configuration option (section "mailgw")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
503 is treated as UTF-8 string. In previous versions, it was ISO8859-1.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
504
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
505 If you have running trackers based on the classic template, please
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
506 update the messagesummary detector as follows::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
507
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
508 --- detectors/messagesummary.py 17 Apr 2003 03:26:38 -0000 1.1
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
509 +++ detectors/messagesummary.py 3 Apr 2007 06:47:21 -0000 1.2
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
510 @@ -8,7 +8,7 @@
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
511 if newvalues.has_key('summary') or not newvalues.has_key('content'):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
512 return
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
513
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
514 - summary, content = parseContent(newvalues['content'], 1, 1)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
515 + summary, content = parseContent(newvalues['content'], config=db.config)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
516 newvalues['summary'] = summary
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
517
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
518 In the latest version we have added some database indexes to the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
519 SQL-backends (mysql, postgresql, sqlite) for speeding up building the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
520 roundup-index for full-text search. We recommend that you create the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
521 following database indexes on the database by hand::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
522
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
523 CREATE INDEX words_by_id ON __words (_textid);
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
524 CREATE UNIQUE INDEX __textids_by_props ON __textids (_class, _itemid, _prop);
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
525
7458
fe16ff1bede5 Add extra explanation for SQL command in 1.3.3->1.4.0 upgrade path
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
526 You can find out which database backend you are using by looking at
fe16ff1bede5 Add extra explanation for SQL command in 1.3.3->1.4.0 upgrade path
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
527 the ``db/backend_name`` file in the tracker's home directory. The
fe16ff1bede5 Add extra explanation for SQL command in 1.3.3->1.4.0 upgrade path
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
528 username, password, and database name can all be found in the
fe16ff1bede5 Add extra explanation for SQL command in 1.3.3->1.4.0 upgrade path
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
529 ``config.ini`` file if you are using ``mysql`` or ``postgresql``. You
fe16ff1bede5 Add extra explanation for SQL command in 1.3.3->1.4.0 upgrade path
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
530 can run the SQL commands using the native client interface: ``psql``
fe16ff1bede5 Add extra explanation for SQL command in 1.3.3->1.4.0 upgrade path
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
531 (postgres), ``mysql`` (MySQL), or ``sqlite3`` (SQLite).
fe16ff1bede5 Add extra explanation for SQL command in 1.3.3->1.4.0 upgrade path
John Rouillard <rouilj@ieee.org>
parents: 7354
diff changeset
532
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
533 .. index:: Upgrading; 1.2.x to 1.3.0
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
534
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
535 Migrating from 1.2.x to 1.3.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
536 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
537
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
538 1.3.0 Web interface changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
539 ---------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
540
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
541 Some of the HTML files in the "classic" and "minimal" tracker templates
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
542 were changed to fix some bugs and clean them up. You may wish to compare
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
543 them to the HTML files in your tracker and apply any changes.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
544
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
545
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
546 .. index:: Upgrading; 1.1.2 to 1.2.0
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
547
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
548 Migrating from 1.1.2 to 1.2.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
549 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
550
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
551 1.2.0 Sorting and grouping by multiple properties
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
552 -------------------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
553
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
554 Starting with this version, sorting and grouping by multiple properties
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
555 is possible. This means that request.sort and request.group are now
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
556 lists. This is reflected in several places:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
557
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
558 * ``renderWith`` now has list attributes for ``sort`` and ``group``,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
559 where you previously wrote::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
560
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
561 renderWith(... sort=('-', 'activity'), group=('+', 'priority')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
562
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
563 you write now::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
564
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
565 renderWith(... sort=[('-', 'activity')], group=[('+', 'priority')]
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
566
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
567 * In templates that permit to edit sorting/grouping, request.sort and
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
568 request.group are (possibly empty) lists. You can now sort and group
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
569 by multiple attributes. For an example, see the classic template. You
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
570 may want search for the variable ``n_sort`` which can be set to the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
571 number of sort/group properties.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
572
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
573 * Templates that diplay new headlines for each group of items with
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
574 equal group properties can now use the modified ``batch.propchanged``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
575 method that can take several properties which are checked for
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
576 changes. See the example in the classic template which makes use of
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
577 ``batch.propchanged``.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
578
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
579 .. index:: Upgrading; 1.1.0 to 1.1.1
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
580
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
581 Migrating from 1.1.0 to 1.1.1
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
582 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
583
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
584 1.1.1 "Clear this message"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
585 --------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
586
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
587 In 1.1.1, the standard ``page.html`` template includes a "clear this message"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
588 link in the green "ok" message bar that appears after a successful edit
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
589 (or other) action.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
590
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
591 To include this in your tracker, change the following in your ``page.html``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
592 template::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
593
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
594 <p tal:condition="options/ok_message | nothing" class="ok-message"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
595 tal:repeat="m options/ok_message" tal:content="structure m">error</p>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
596
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
597 to be::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
598
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
599 <p tal:condition="options/ok_message | nothing" class="ok-message">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
600 <span tal:repeat="m options/ok_message"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
601 tal:content="structure string:$m <br/ > " />
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
602 <a class="form-small" tal:attributes="href request/current_url"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
603 i18n:translate="">clear this message</a>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
604 </p>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
605
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
606
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
607 If you implemented the "clear this message" in your 1.1.0 tracker, then you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
608 should change it to the above and it will work much better!
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
609
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
610
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
611 .. index:: Upgrading; 1.0.x to 1.1.0
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
612
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
613 Migrating from 1.0.x to 1.1.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
614 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
615
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
616 1.1 Login "For Session Only"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
617 ----------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
618
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
619 In 1.1, web logins are alive for the length of a session only, *unless* you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
620 add the following to the login form in your tracker's ``page.html``::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
621
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
622 <input type="checkbox" name="remember" id="remember">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
623 <label for="remember" i18n:translate="">Remember me?</label><br>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
624
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
625 See the classic tracker ``page.html`` if you're unsure where this should
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
626 go.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
627
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
628
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
629 1.1 Query Display Name
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
630 ----------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
631
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
632 The ``dispname`` web variable has been renamed ``@dispname`` to avoid
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
633 clashing with other variables of the same name. If you are using the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
634 display name feature, you will need to edit your tracker's ``page.html``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
635 and ``issue.index.html`` pages to change ``dispname`` to ``@dispname``.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
636
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
637 A side-effect of this change is that the renderWith method used in the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
638 ``home.html`` page may now take a dispname argument.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
639
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
640
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
641 1.1 "Clear this message"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
642 ------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
643
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
644 In 1.1, the standard ``page.html`` template includes a "clear this message"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
645 link in the green "ok" message bar that appears after a successful edit
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
646 (or other) action.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
647
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
648 To include this in your tracker, change the following in your ``page.html``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
649 template::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
650
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
651 <p tal:condition="options/ok_message | nothing" class="ok-message"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
652 tal:repeat="m options/ok_message" tal:content="structure m">error</p>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
653
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
654 to be::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
655
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
656 <p tal:condition="options/ok_message | nothing" class="ok-message">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
657 <span tal:repeat="m options/ok_message"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
658 tal:content="structure string:$m <br/ > " />
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
659 <a class="form-small" tal:attributes="href string:issue${context/id}"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
660 i18n:translate="">clear this message</a>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
661 </p>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
662
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
663
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
664 .. index:: Upgrading; 0.8.x to 1.0
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
665
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
666 Migrating from 0.8.x to 1.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
667 ===========================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
668
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
669 1.0 New Query Permissions
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
670 -------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
671
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
672 New permissions are defined for query editing and viewing. To include these
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
673 in your tracker, you need to add these lines to your tracker's
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
674 ``schema.py``::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
675
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
676 # Users should be able to edit and view their own queries. They should also
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
677 # be able to view any marked as not private. They should not be able to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
678 # edit others' queries, even if they're not private
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
679 def view_query(db, userid, itemid):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
680 private_for = db.query.get(itemid, 'private_for')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
681 if not private_for: return True
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
682 return userid == private_for
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
683 def edit_query(db, userid, itemid):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
684 return userid == db.query.get(itemid, 'creator')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
685 p = db.security.addPermission(name='View', klass='query', check=view_query,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
686 description="User is allowed to view their own and public queries")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
687 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
688 p = db.security.addPermission(name='Edit', klass='query', check=edit_query,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
689 description="User is allowed to edit their queries")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
690 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
691 p = db.security.addPermission(name='Create', klass='query',
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
692 description="User is allowed to create queries")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
693 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
694
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
695 and then remove 'query' from the line::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
696
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
697 # Assign the access and edit Permissions for issue, file and message
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
698 # to regular users now
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
699 for cl in 'issue', 'file', 'msg', 'query', 'keyword':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
700
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
701 so it looks like::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
702
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
703 for cl in 'issue', 'file', 'msg', 'keyword':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
704
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
705
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
706 .. index:: Upgrading; 0.8.0 to 0.8.3
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
707
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
708 Migrating from 0.8.0 to 0.8.3
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
709 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
710
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
711 0.8.3 Nosy Handling Changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
712 ---------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
713
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
714 A change was made to fix a bug in the ``nosyreaction.py`` standard
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
715 detector. To incorporate this fix in your trackers, you will need to copy
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
716 the ``nosyreaction.py`` file from the ``templates/classic/detectors``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
717 directory of the source to your tracker's ``templates`` directory.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
718
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
719 If you have modified the ``nosyreaction.py`` file from the standard
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
720 version, you will need to roll your changes into the new file.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
721
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
722
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
723 .. index:: Upgrading; 0.7.1 to 0.8.0
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
724
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
725 Migrating from 0.7.1 to 0.8.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
726 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
727
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
728 You *must* fully uninstall previous Roundup version before installing
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
729 Roundup 0.8.0. If you don't do that, ``roundup-admin install``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
730 command may fail to function properly.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
731
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
732 0.8.0 Backend changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
733 ---------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
734
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
735 Backends 'bsddb' and 'bsddb3' are removed. If you are using one of these,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
736 you *must* migrate to another backend before upgrading.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
737
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
738
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
739 0.8.0 API changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
740 -----------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
741
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
742 Class.safeget() was removed from the API. Test your item ids before calling
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
743 Class.get() instead.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
744
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
745
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
746 0.8.0 New tracker layout
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
747 ------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
748
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
749 The ``config.py`` file has been replaced by ``config.ini``. You may use the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
750 roundup-admin command "genconfig" to generate a new config file::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
751
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
752 roundup-admin genconfig <tracker home>/config.ini
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
753
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
754 and modify the values therein based on the contents of your old config.py.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
755 In most cases, the names of the config variables are the same.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
756
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
757 The ``select_db.py`` file has been replaced by a file in the ``db``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
758 directory called ``backend_name``. As you might guess, this file contains
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
759 just the name of the backend. To figure what the contents of yours should
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
760 be, use the following table:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
761
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
762 ================================ =========================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
763 ``select_db.py`` contents ``backend_name`` contents
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
764 ================================ =========================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
765 from back_anydbm import ... anydbm
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
766 from back_metakit import ... metakit
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
767 from back_sqlite import ... sqlite
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
768 from back_mysql import ... mysql
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
769 from back_postgresql import ... postgresql
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
770 ================================ =========================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
771
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
772 The ``dbinit.py`` file has been split into two new files,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
773 ``initial_data.py`` and ``schema.py``. The contents of this file are:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
774
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
775 ``initial_data.py``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
776 You don't need one of these as your tracker is already initialised.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
777
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
778 ``schema.py``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
779 Copy the body of the ``def open(name=None)`` function from your old
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
780 tracker's ``dbinit.py`` file to this file. As the lines you're copying
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
781 aren't part of a function definition anymore, one level of indentation
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
782 needs to be removed (remove only the leading four spaces on each
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
783 line).
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
784
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
785 The first few lines -- those starting with ``from roundup.hyperdb
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
786 import ...`` and the ``db = Database(config, name)`` line -- don't
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
787 need to be copied. Neither do the last few lines -- those starting
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
788 with ``import detectors``, down to ``return db`` inclusive.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
789
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
790 You may remove the ``__init__.py`` module from the "detectors" directory as
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
791 it is no longer used.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
792
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
793 There's a new way to write extension code for Roundup. If you have code in
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
794 an ``interfaces.py`` file you should move it. See the `customisation
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
795 documentation`_ for information about how extensions are now written.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
796 Note that some older trackers may use ``interfaces.py`` to customise the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
797 mail gateway behaviour. You will need to keep your ``interfaces.py`` file
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
798 if this is the case.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
799
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
800
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
801 0.8.0 Permissions Changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
802 -------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
803
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
804 The creation of a new item in the user interfaces is now controlled by the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
805 "Create" Permission. You will need to add an assignment of this Permission
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
806 to your users who are allowed to create items. The most common form of this
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
807 is the following in your ``schema.py`` added just under the current
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
808 assignation of the Edit Permission::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
809
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
810 for cl in 'issue', 'file', 'msg', 'query', 'keyword':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
811 p = db.security.getPermission('Create', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
812 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
813
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
814 You will need to explicitly let anonymous users access the web interface so
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
815 that regular users are able to see the login form. Note that almost all
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
816 trackers will need this Permission. The only situation where it's not
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
817 required is in a tracker that uses an HTTP Basic Authenticated front-end.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
818 It's enabled by adding to your ``schema.py``::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
819
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
820 p = db.security.getPermission('Web Access')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
821 db.security.addPermissionToRole('Anonymous', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
822
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
823 Finally, you will need to enable permission for your users to edit their
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
824 own details by adding the following to ``schema.py``::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
825
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
826 # Users should be able to edit their own details. Note that this
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
827 # permission is limited to only the situation where the Viewed or
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
828 # Edited item is their own.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
829 def own_record(db, userid, itemid):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
830 '''Determine whether the userid matches the item being accessed.'''
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
831 return userid == itemid
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
832 p = db.security.addPermission(name='View', klass='user', check=own_record,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
833 description="User is allowed to view their own user details")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
834 p = db.security.addPermission(name='Edit', klass='user', check=own_record,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
835 description="User is allowed to edit their own user details")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
836 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
837
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
838
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
839 0.8.0 Use of TemplatingUtils
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
840 ----------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
841
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
842 If you used custom python functions in TemplatingUtils, they must
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
843 be moved from interfaces.py to a new file in the ``extensions`` directory.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
844
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
845 Each Function that should be available through TAL needs to be defined
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
846 as a toplevel function in the newly created file. Furthermore you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
847 add an inititialization function, that registers the functions with the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
848 tracker.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
849
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
850 If you find this too tedious, donfu wrote an automatic init function that
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
851 takes an existing TemplatingUtils class, and registers all class methods
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
852 that do not start with an underscore. The following hack should be placed
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
853 in the ``extensions`` directory alongside other extensions::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
854
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
855 class TemplatingUtils:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
856 # copy from interfaces.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
857
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
858 def init(tracker):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
859 util = TemplatingUtils()
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
860
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
861 def setClient(tu):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
862 util.client = tu.client
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
863 return util
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
864
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
865 def execUtil(name):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
866 return lambda tu, *args, **kwargs: \
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
867 getattr(setClient(tu), name)(*args, **kwargs)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
868
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
869 for name in dir(util):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
870 if callable(getattr(util, name)) and not name.startswith('_'):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
871 tracker.registerUtil(name, execUtil(name))
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
872
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
873
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
874 0.8.0 Logging Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
875 ---------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
876
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
877 See the `administration guide`_ for information about configuring the new
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
878 logging implemented in 0.8.0.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
879
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
880
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
881 .. index:: Upgrading; 0.7.2 to 0.7.3
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
882
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
883 Migrating from 0.7.2 to 0.7.3
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
884 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
885
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
886 0.7.3 Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
887 -------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
888
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
889 If you choose, you may specify the directory from which static files are
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
890 served (those which use the URL component ``@@file``). Currently the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
891 directory defaults to the ``TEMPLATES`` configuration variable. You may
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
892 define a new variable, ``STATIC_FILES`` which overrides this value for
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
893 static files.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
894
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
895
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
896 .. index:: Upgrading; 0.7.0 to 0.7.2
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
897
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
898 Migrating from 0.7.0 to 0.7.2
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
899 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
900
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
901 0.7.2 DEFAULT_TIMEZONE is now required
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
902 --------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
903
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
904 The DEFAULT_TIMEZONE configuration variable is now required. Add the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
905 following to your tracker's ``config.py`` file::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
906
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
907 # You may specify a different default timezone, for use when users do not
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
908 # choose their own in their settings.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
909 DEFAULT_TIMEZONE = 0 # specify as numeric hour offest
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
910
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
911 .. index:: Upgrading; 0.7.0 to 0.7.1
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
912
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
913 Migrating from 0.7.0 to 0.7.1
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
914 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
915
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
916 0.7.1 Permission assignments
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
917 ----------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
918
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
919 If you allow anonymous access to your tracker, you might need to assign
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
920 some additional View (or Edit if your tracker is that open) permissions
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
921 to the "anonymous" user. To do so, find the code in your ``dbinit.py`` that
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
922 says::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
923
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
924 for cl in 'issue', 'file', 'msg', 'query', 'keyword':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
925 p = db.security.getPermission('View', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
926 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
927 p = db.security.getPermission('Edit', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
928 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
929 for cl in 'priority', 'status':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
930 p = db.security.getPermission('View', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
931 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
932
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
933 Add add a line::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
934
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
935 db.security.addPermissionToRole('Anonymous', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
936
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
937 next to the existing ``'User'`` lines for the Permissions you wish to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
938 assign to the anonymous user.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
939
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
940
7843
3f2d743824e9 doc: fix index term - used upgrading should be Upgrading.
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
941 .. index:: Upgrading; versions earlier than 0.7
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
942
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
943 Migrating from 0.6 to 0.7
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
944 =========================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
945
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
946 0.7.0 Permission assignments
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
947 ----------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
948
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
949 Due to a change in the rendering of web widgets, permissions are now
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
950 checked on Classes where they previously weren't (this is a good thing).
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
951
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
952 You will need to add some additional Permission assignments for your
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
953 regular users, or some displays will break. After the following in your
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
954 tracker's ``dbinit.py``::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
955
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
956 # Assign the access and edit Permissions for issue, file and message
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
957 # to regular users now
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
958 for cl in 'issue', 'file', 'msg', 'query', 'keyword':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
959 p = db.security.getPermission('View', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
960 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
961 p = db.security.getPermission('Edit', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
962 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
963
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
964 add::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
965
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
966 for cl in 'priority', 'status':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
967 p = db.security.getPermission('View', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
968 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
969
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
970
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
971 0.7.0 Getting the current user id
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
972 ---------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
973
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
974 The Database.curuserid attribute has been removed.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
975
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
976 Any code referencing this attribute should be replaced with a
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
977 call to Database.getuid().
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
978
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
979
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
980 0.7.0 ZRoundup changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
981 ----------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
982
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
983 The templates in your tracker's html directory will need updating if you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
984 wish to use ZRoundup. If you've not modified those files (or some of them),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
985 you may just copy the new versions from the Roundup source in the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
986 templates/classic/html directory.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
987
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
988 If you have modified the html files, then you'll need to manually edit them
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
989 to change all occurances of special form variables from using the colon ":"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
990 special character to the at "@" special character. That is, variables such
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
991 as::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
992
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
993 :action :required :template :remove:messages ...
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
994
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
995 should become::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
996
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
997 @action @required @template @remove@messages ...
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
998
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
999 Note that ``tal:`` statements are unaffected. So are TAL expression type
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1000 prefixes such as ``python:`` and ``string:``. Please ask on the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1001 roundup-users mailing list for help if you're unsure.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1002
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1003
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1004 0.7.0 Edit collision detection
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1005 ------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1006
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1007 Roundup now detects collisions with editing in the web interface (that is,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1008 two people editing the same item at the same time).
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1009
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1010 You must copy the ``_generic.collision.html`` file from Roundup source in
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1011 the ``templates/classic/html`` directory. to your tracker's ``html``
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1012 directory.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1013
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1014
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1015 Migrating from 0.6.x to 0.6.3
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1016 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1017
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1018 0.6.3 Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1019 -------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1020
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1021 You will need to copy the file::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1022
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1023 templates/classic/detectors/__init__.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1024
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1025 to your tracker's ``detectors`` directory, replacing the one already there.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1026 This fixes a couple of bugs in that file.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1027
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1028
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1029
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1030 Migrating from 0.5 to 0.6
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1031 =========================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1032
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1033
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1034 0.6.0 Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1035 -------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1036
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1037 Introduced EMAIL_FROM_TAG config variable. This value is inserted into
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1038 the From: line of nosy email. If the sending user is "Foo Bar", the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1039 From: line is usually::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1040
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1041 "Foo Bar" <issue_tracker@tracker.example>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1042
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1043 the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1044
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1045 "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1046
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1047 I've altered the mechanism in the detectors __init__.py module so that it
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1048 doesn't cross-import detectors from other trackers (if you run more than one
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1049 in a single roundup-server). This change means that you'll need to copy the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1050 __init__.py from roundup/templates/classic/detectors/__init__.py to your
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1051 <tracker home>/detectors/__init__.py. Don't worry, the "classic" __init__ is a
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1052 one-size-fits-all, so it'll work even if you've added/removed detectors.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1053
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1054 0.6.0 Templating changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1055 ------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1056
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1057 The ``user.item`` template (in the tracker home "templates" directory)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1058 needs to have the following hidden variable added to its form (between the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1059 ``<form...>`` and ``</form>`` tags::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1060
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1061 <input type="hidden" name=":template" value="item">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1062
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1063
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1064 0.6.0 Form handling changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1065 ---------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1066
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1067 Roundup's form handling capabilities have been significantly expanded. This
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1068 should not affect users of 0.5 installations - but if you find you're
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1069 getting errors from form submissions, please ask for help on the Roundup
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1070 users mailing list:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1071
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1072 https://sourceforge.net/projects/roundup/lists/roundup-users
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1073
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1074 See the customisation doc section on `Form Values`__ for documentation of the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1075 new form variables possible.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1076
7354
692242b3effd initial pass to change references to reference doc where needed.
John Rouillard <rouilj@ieee.org>
parents: 7281
diff changeset
1077 __ reference.html#form-values
7281
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1078
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1079
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1080 0.6.0 Multilingual character set support
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1081 ----------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1082
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1083 Added internationalization support. This is done via encoding all data
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1084 stored in roundup database to utf-8 (unicode encoding). To support utf-8 in
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1085 web interface you should add the folowing line to your tracker's html/page
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1086 and html/_generic.help files inside <head> tag::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1087
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1088 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1089
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1090 Since latin characters in utf-8 have the same codes as in ASCII table, this
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1091 modification is optional for users who use only plain latin characters.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1092
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1093 After this modification, you will be able to see and enter any world
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1094 character via web interface. Data received via mail interface also converted
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1095 to utf-8, however only new messages will be converted. If your roundup
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1096 database contains some of non-ASCII characters in one of 8-bit encoding,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1097 they will not be visible in new unicode environment. Some of such data (e.g.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1098 user names, keywords, etc) can be edited by administrator, the others
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1099 (e.g. messages' contents) is not editable via web interface. Currently there
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1100 is no tool for converting such data, the only solution is to close
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1101 appropriate old issues and create new ones with the same content.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1102
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1103
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1104 0.6.0 User timezone support
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1105 ---------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1106
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1107 From version 0.6.0 roundup supports displaying of Date data in user' local
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1108 timezone if he/she has provided timezone information. To make it possible
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1109 some modification to tracker's schema and HTML templates are required.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1110 First you must add string property 'timezone' to user class in dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1111 like this::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1112
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1113 user = Class(db, "user",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1114 username=String(), password=Password(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1115 address=String(), realname=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1116 phone=String(), organisation=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1117 alternate_addresses=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1118 queries=Multilink('query'), roles=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1119 timezone=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1120
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1121 And second - html interface. Add following lines to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1122 $TRACKER_HOME/html/user.item template::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1123
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1124 <tr>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1125 <th>Timezone</th>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1126 <td tal:content="structure context/timezone/field">timezone</td>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1127 </tr>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1128
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1129 After that all users should be able to provide their timezone information.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1130 Timezone should be a positive or negative integer - offset from GMT.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1131
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1132 After providing timezone, roundup will show all dates values, found in web
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1133 and mail interfaces in local time. It will also accept any Date info in
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1134 local time, convert and store it in GMT.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1135
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1136
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1137 0.6.0 Search page structure
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1138 ---------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1139
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1140 In order to accomodate query editing the search page has been restructured. If
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1141 you want to provide your users with query editing, you should update your
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1142 search page using the macros detailed in the customisation doc section
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1143 `Searching on categories`__.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1144
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1145 __ customizing.html#searching-on-categories
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1146
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1147 Also, the url field in the query class no longer starts with a '?'. You'll need
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1148 to remove this question mark from the url field to support queries. There's
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1149 a script in the "tools" directory called ``migrate-queries.py`` that should
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1150 automatically change any existing queries for you. As always, make a backup
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1151 of your database before running such a script.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1152
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1153
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1154 0.6.0 Notes for metakit backend users
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1155 -------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1156
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1157 Roundup 0.6.0 introduced searching on ranges of dates and intervals. To
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1158 support it, some modifications to interval storing routine were made. So if
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1159 your tracker uses metakit backend and your db schema contains intervals
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1160 property, searches on that property will not be accurate for db items that
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1161 was stored before roundup' upgrade. However all new records should be
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1162 searchable on intervals.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1163
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1164 It is possible to convert your database to new format: you can export and
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1165 import back all your data (consult "Migrating backends" in "Maintenance"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1166 documentation). After this operation all your interval properties should
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1167 become searchable.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1168
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1169 Users of backends others than metakit should not worry about this issue.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1170
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1171
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1172 Migrating from 0.4.x to 0.5.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1173 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1174
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1175 This has been a fairly major revision of Roundup:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1176
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1177 1. Brand new, much more powerful, flexible, tasty and nutritious templating.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1178 Unfortunately, this means all your current templates are useless. Hopefully
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1179 the new documentation and examples will be enough to help you make the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1180 transition. Please don't hesitate to ask on roundup-users for help (or
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1181 complete conversions if you're completely stuck)!
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1182 2. The database backed got a lot more flexible, allowing Metakit and SQL
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1183 databases! The only decent SQL database implemented at present is sqlite,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1184 but others shouldn't be a whole lot more work.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1185 3. A brand new, highly flexible and much more robust security system including
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1186 a system of Permissions, Roles and Role assignments to users. You may now
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1187 define your own Permissions that may be checked in CGI transactions.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1188 4. Journalling has been made less storage-hungry, so has been turned on
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1189 by default *except* for author, recipient and nosy link/unlink events. You
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1190 are advised to turn it off in your trackers too.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1191 5. We've changed the terminology from "instance" to "tracker", to ease the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1192 learning curve/impact for new users.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1193 6. Because of the above changes, the tracker configuration has seen some
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1194 major changes. See below for the details.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1195
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1196 Please, **back up your database** before you start the migration process. This
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1197 is as simple as copying the "db" directory and all its contents from your
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1198 tracker to somewhere safe.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1199
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1200
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1201 0.5.0 Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1202 -------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1203
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1204 First up, rename your ``instance_config.py`` file to just ``config.py``.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1205
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1206 Then edit your tracker's ``__init__.py`` module. It'll currently look
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1207 like this::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1208
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1209 from instance_config import *
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1210 try:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1211 from dbinit import *
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1212 except ImportError:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1213 pass # in installdir (probably :)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1214 from interfaces import *
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1215
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1216 and it needs to be::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1217
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1218 import config
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1219 from dbinit import open, init
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1220 from interfaces import Client, MailGW
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1221
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1222 Due to the new templating having a top-level ``page`` that defines links for
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1223 searching, indexes, adding items etc, the following variables are no longer
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1224 used:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1225
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1226 - HEADER_INDEX_LINKS
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1227 - HEADER_ADD_LINKS
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1228 - HEADER_SEARCH_LINKS
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1229 - SEARCH_FILTERS
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1230 - DEFAULT_INDEX
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1231 - UNASSIGNED_INDEX
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1232 - USER_INDEX
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1233 - ISSUE_FILTER
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1234
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1235 The new security implementation will require additions to the dbinit module,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1236 but also removes the need for the following tracker config variables:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1237
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1238 - ANONYMOUS_ACCESS
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1239 - ANONYMOUS_REGISTER
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1240
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1241 but requires two new variables which define the Roles assigned to users who
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1242 register through the web and e-mail interfaces:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1243
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1244 - NEW_WEB_USER_ROLES
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1245 - NEW_EMAIL_USER_ROLES
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1246
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1247 in both cases, 'User' is a good initial setting. To emulate
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1248 ``ANONYMOUS_ACCESS='deny'``, remove all "View" Permissions from the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1249 "Anonymous" Role. To emulate ``ANONYMOUS_REGISTER='deny'``, remove the "Web
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1250 Registration" and/or the "Email Registration" Permission from the "Anonymous"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1251 Role. See the section on customising security in the `customisation
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1252 documentation`_ for more information.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1253
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1254 Finally, the following config variables have been renamed to make more sense:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1255
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1256 - INSTANCE_HOME -> TRACKER_HOME
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1257 - INSTANCE_NAME -> TRACKER_NAME
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1258 - ISSUE_TRACKER_WEB -> TRACKER_WEB
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1259 - ISSUE_TRACKER_EMAIL -> TRACKER_EMAIL
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1260
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1261
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1262 0.5.0 Schema Specification
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1263 --------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1264
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1265 0.5.0 Database backend changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1267
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1268 Your select_db module in your tracker has changed a fair bit. Where it used
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1269 to contain::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1270
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1271 # WARNING: DO NOT EDIT THIS FILE!!!
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1272 from roundup.backends.back_anydbm import Database
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1273
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1274 it must now contain::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1275
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1276 # WARNING: DO NOT EDIT THIS FILE!!!
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1277 from roundup.backends.back_anydbm import Database, Class, FileClass, IssueClass
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1278
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1279 Yes, I realise the irony of the "DO NOT EDIT THIS FILE" statement :)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1280 Note the addition of the Class, FileClass, IssueClass imports. These are very
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1281 important, as they're going to make the next change work too. You now need to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1282 modify the top of the dbinit module in your tracker from::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1283
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1284 import instance_config
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1285 from roundup import roundupdb
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1286 from select_db import Database
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1287
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1288 from roundup.roundupdb import Class, FileClass
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1289
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1290 class Database(roundupdb.Database, select_db.Database):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1291 ''' Creates a hybrid database from:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1292 . the selected database back-end from select_db
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1293 . the roundup extensions from roundupdb
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1294 '''
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1295 pass
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1296
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1297 class IssueClass(roundupdb.IssueClass):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1298 ''' issues need the email information
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1299 '''
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1300 pass
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1301
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1302 to::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1303
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1304 import config
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1305 from select_db import Database, Class, FileClass, IssueClass
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1306
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1307 Yes, remove the Database and IssueClass definitions and those other imports.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1308 They're not needed any more!
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1309
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1310 Look for places in dbinit.py where ``instance_config`` is used too, and
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1311 rename them ``config``.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1312
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1313
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1314 0.5.0 Journalling changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1315 ~~~~~~~~~~~~~~~~~~~~~~~~~
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1316
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1317 Journalling has been optimised for storage. Journalling of links has been
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1318 turned back on by default. If your tracker has a large user base, you may wish
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1319 to turn off journalling of nosy list, message author and message recipient
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1320 link and unlink events. You do this by adding ``do_journal='no'`` to the Class
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1321 initialisation in your dbinit. For example, your *msg* class initialisation
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1322 probably looks like this::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1323
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1324 msg = FileClass(db, "msg",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1325 author=Link("user"), recipients=Multilink("user"),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1326 date=Date(), summary=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1327 files=Multilink("file"),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1328 messageid=String(), inreplyto=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1329
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1330 to turn off journalling of author and recipient link events, add
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1331 ``do_journal='no'`` to the ``author=Link("user")`` part of the statement,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1332 like so::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1333
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1334 msg = FileClass(db, "msg",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1335 author=Link("user", do_journal='no'),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1336 recipients=Multilink("user", do_journal='no'),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1337 date=Date(), summary=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1338 files=Multilink("file"),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1339 messageid=String(), inreplyto=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1340
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1341 Nosy list link event journalling is actually turned off by default now. If you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1342 want to turn it on, change to your issue class' nosy list, change its
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1343 definition from::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1344
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1345 issue = IssueClass(db, "issue",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1346 assignedto=Link("user"), topic=Multilink("keyword"),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1347 priority=Link("priority"), status=Link("status"))
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1348
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1349 to::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1350
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1351 issue = IssueClass(db, "issue", nosy=Multilink("user", do_journal='yes'),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1352 assignedto=Link("user"), topic=Multilink("keyword"),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1353 priority=Link("priority"), status=Link("status"))
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1354
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1355 noting that your definition of the nosy Multilink will override the normal one.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1356
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1357
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1358 0.5.0 User schema changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1359 ~~~~~~~~~~~~~~~~~~~~~~~~~
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1360
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1361 Users have two more properties, "queries" and "roles". You'll have something
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1362 like this in your dbinit module now::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1363
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1364 user = Class(db, "user",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1365 username=String(), password=Password(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1366 address=String(), realname=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1367 phone=String(), organisation=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1368 alternate_addresses=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1369 user.setkey("username")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1370
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1371 and you'll need to add the new properties and the new "query" class to it
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1372 like so::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1373
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1374 query = Class(db, "query",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1375 klass=String(), name=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1376 url=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1377 query.setkey("name")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1378
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1379 # Note: roles is a comma-separated string of Role names
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1380 user = Class(db, "user",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1381 username=String(), password=Password(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1382 address=String(), realname=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1383 phone=String(), organisation=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1384 alternate_addresses=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1385 queries=Multilink('query'), roles=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1386 user.setkey("username")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1387
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1388 The "queries" property is used to store off the user's favourite database
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1389 queries. The "roles" property is explained below in `0.5.0 Security
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1390 Settings`_.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1391
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1392
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1393 0.5.0 Security Settings
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1394 ~~~~~~~~~~~~~~~~~~~~~~~
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1395
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1396 See the `security documentation`_ for an explanation of how the new security
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1397 system works. In a nutshell though, the security is handled as a four step
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1398 process:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1399
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1400 1. Permissions are defined as having a name and optionally a hyperdb class
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1401 they're specific to,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1402 2. Roles are defined that have one or more Permissions,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1403 3. Users are assigned Roles in their "roles" property, and finally
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1404 4. Roundup checks that users have appropriate Permissions at appropriate times
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1405 (like editing issues).
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1406
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1407 Your tracker dbinit module's *open* function now has to define any
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1408 Permissions that are specific to your tracker, and also the assignment
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1409 of Permissions to Roles. At the moment, your open function
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1410 ends with::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1411
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1412 import detectors
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1413 detectors.init(db)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1414
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1415 return db
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1416
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1417 and what we need to do is insert some commands that will set up the security
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1418 parameters. Right above the ``import detectors`` line, you'll want to insert
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1419 these lines::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1420
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1421 #
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1422 # SECURITY SETTINGS
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1423 #
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1424 # new permissions for this schema
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1425 for cl in 'issue', 'file', 'msg', 'user':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1426 db.security.addPermission(name="Edit", klass=cl,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1427 description="User is allowed to edit "+cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1428 db.security.addPermission(name="View", klass=cl,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1429 description="User is allowed to access "+cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1430
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1431 # Assign the access and edit permissions for issue, file and message
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1432 # to regular users now
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1433 for cl in 'issue', 'file', 'msg':
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1434 p = db.security.getPermission('View', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1435 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1436 p = db.security.getPermission('Edit', cl)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1437 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1438 # and give the regular users access to the web and email interface
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1439 p = db.security.getPermission('Web Access')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1440 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1441 p = db.security.getPermission('Email Access')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1442 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1443
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1444 # May users view other user information? Comment these lines out
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1445 # if you don't want them to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1446 p = db.security.getPermission('View', 'user')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1447 db.security.addPermissionToRole('User', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1448
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1449 # Assign the appropriate permissions to the anonymous user's Anonymous
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1450 # Role. Choices here are:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1451 # - Allow anonymous users to register through the web
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1452 p = db.security.getPermission('Web Registration')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1453 db.security.addPermissionToRole('Anonymous', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1454 # - Allow anonymous (new) users to register through the email gateway
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1455 p = db.security.getPermission('Email Registration')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1456 db.security.addPermissionToRole('Anonymous', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1457 # - Allow anonymous users access to the "issue" class of data
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1458 # Note: this also grants access to related information like files,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1459 # messages, statuses etc that are linked to issues
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1460 #p = db.security.getPermission('View', 'issue')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1461 #db.security.addPermissionToRole('Anonymous', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1462 # - Allow anonymous users access to edit the "issue" class of data
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1463 # Note: this also grants access to create related information like
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1464 # files and messages etc that are linked to issues
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1465 #p = db.security.getPermission('Edit', 'issue')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1466 #db.security.addPermissionToRole('Anonymous', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1467
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1468 # oh, g'wan, let anonymous access the web interface too
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1469 p = db.security.getPermission('Web Access')
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1470 db.security.addPermissionToRole('Anonymous', p)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1471
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1472 Note in the comments there the places where you might change the permissions
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1473 to restrict users or grant users more access. If you've created additional
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1474 classes that users should be able to edit and view, then you should add them
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1475 to the "new permissions for this schema" section at the start of the security
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1476 block. Then add them to the "Assign the access and edit permissions" section
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1477 too, so people actually have the new Permission you've created.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1478
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1479 One final change is needed that finishes off the security system's
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1480 initialisation. We need to add a call to ``db.post_init()`` at the end of the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1481 dbinit open() function. Add it like this::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1482
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1483 import detectors
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1484 detectors.init(db)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1485
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1486 # schema is set up - run any post-initialisation
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1487 db.post_init()
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1488 return db
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1489
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1490 You may verify the setup of Permissions and Roles using the new
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1491 "``roundup-admin security``" command.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1492
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1493
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1494 0.5.0 User changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1495 ~~~~~~~~~~~~~~~~~~
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1496
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1497 To support all those schema changes, you'll need to massage your user database
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1498 a little too, to:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1499
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1500 1. make sure there's an "anonymous" user - this user is mandatory now and is
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1501 the one that unknown users are logged in as.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1502 2. make sure all users have at least one Role.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1503
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1504 If you don't have the "anonymous" user, create it now with the command::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1505
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1506 roundup-admin create user username=anonymous roles=Anonymous
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1507
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1508 making sure the capitalisation is the same as above. Once you've done that,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1509 you'll need to set the roles property on all users to a reasonable default.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1510 The admin user should get "Admin", the anonymous user "Anonymous"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1511 and all other users "User". The ``fixroles.py`` script in the tools directory
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1512 will do this. Run it like so (where python is your python 2+ binary)::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1513
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1514 python tools/fixroles.py -i <tracker home> fixroles
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1515
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1516
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1517
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1518 0.5.0 CGI interface changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1519 ---------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1520
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1521 The CGI interface code was completely reorganised and largely rewritten. The
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1522 end result is that this section of your tracker interfaces module will need
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1523 changing from::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1524
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1525 from roundup import cgi_client, mailgw
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1526 from roundup.i18n import _
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1527
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1528 class Client(cgi_client.Client):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1529 ''' derives basic CGI implementation from the standard module,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1530 with any specific extensions
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1531 '''
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1532 pass
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1533
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1534 to::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1535
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1536 from roundup import mailgw
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1537 from roundup.cgi import client
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1538
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1539 class Client(client.Client):
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1540 ''' derives basic CGI implementation from the standard module,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1541 with any specific extensions
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1542 '''
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1543 pass
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1544
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1545 You will also need to install the new version of roundup.cgi from the source
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1546 cgi-bin directory if you're using it.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1547
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1548
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1549 0.5.0 HTML templating
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1550 ---------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1551
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1552 You'll want to make a backup of your current tracker html directory. You
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1553 should then copy the html directory from the Roundup source "classic" template
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1554 and modify it according to your local schema changes.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1555
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1556 If you need help with the new templating system, please ask questions on the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1557 roundup-users mailing list (available through the roundup web page on
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1558 sourceforge, https://www.roundup-tracker.org/.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1559
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1560
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1561 0.5.0 Detectors
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1562 ---------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1563
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1564 The nosy reactor has been updated to handle the tracker not having an
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1565 "assignedto" property on issues. You may want to copy it into your tracker's
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1566 detectors directory. Chances are you've already fixed it though :)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1567
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1568
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1569 Migrating from 0.4.1 to 0.4.2
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1570 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1571
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1572 0.4.2 Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1573 -------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1574 The USER_INDEX definition introduced in 0.4.1 was too restrictive in its
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1575 allowing replacement of 'assignedto' with the user's userid. Users must change
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1576 the None value of 'assignedto' to 'CURRENT USER' (the string, in quotes) for
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1577 the replacement behaviour to occur now.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1578
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1579 The new configuration variables are:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1580
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1581 - EMAIL_KEEP_QUOTED_TEXT
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1582 - EMAIL_LEAVE_BODY_UNCHANGED
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1583 - ADD_RECIPIENTS_TO_NOSY
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1584
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1585 See the sample configuration files in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1586
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1587 <roundup source>/roundup/templates/classic/instance_config.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1588
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1589 and::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1590
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1591 <roundup source>/roundup/templates/extended/instance_config.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1592
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1593 and the `customisation documentation`_ for information on how they're used.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1594
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1595
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1596 0.4.2 Changes to detectors
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1597 --------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1598 You will need to copy the detectors from the distribution into your instance
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1599 home "detectors" directory. If you used the classic schema, the detectors
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1600 are in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1601
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1602 <roundup source>/roundup/templates/classic/detectors/
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1603
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1604 If you used the extended schema, the detectors are in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1605
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1606 <roundup source>/roundup/templates/extended/detectors/
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1607
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1608 The change means that schema-specific code has been removed from the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1609 mail gateway and cgi interface and made into auditors:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1610
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1611 - nosyreactor.py has now got an updatenosy auditor which updates the nosy
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1612 list with author, recipient and assignedto information.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1613 - statusauditor.py makes the unread or resolved -> chatting changes and
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1614 presets the status of an issue to unread.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1615
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1616 There's also a bug or two fixed in the nosyreactor code.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1617
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1618 0.4.2 HTML templating changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1619 -----------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1620 The link() htmltemplate function now has a "showid" option for links and
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1621 multilinks. When true, it only displays the linked item id as the anchor
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1622 text. The link value is displayed as a tooltip using the title anchor
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1623 attribute. To use in eg. the superseder field, have something like this::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1624
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1625 <td>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1626 <display call="field('superseder', showid=1)">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1627 <display call="classhelp('issue', 'id,title', label='list', width=500)">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1628 <property name="superseder">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1629 <br>View: <display call="link('superseder', showid=1)">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1630 </property>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1631 </td>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1632
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1633 The stylesheets have been cleaned up too. You may want to use the newer
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1634 versions in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1635
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1636 <roundup source>/roundup/templates/<template>/html/default.css
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1637
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1638
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1639
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1640 Migrating from 0.4.0 to 0.4.1
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1641 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1642
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1643 0.4.1 Files storage
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1644 -------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1645
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1646 Messages and files from newly created issues will be put into subdierectories
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1647 in thousands e.g. msg123 will be put into files/msg/0/msg123, file2003
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1648 will go into files/file/2/file2003. Previous messages are still found, but
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1649 could be put into this structure.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1650
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1651 0.4.1 Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1652 -------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1653
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1654 To allow more fine-grained access control, the variable used to check
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1655 permission to auto-register users in the mail gateway is now called
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1656 ANONYMOUS_REGISTER_MAIL rather than overloading ANONYMOUS_REGISTER. If the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1657 variable doesn't exist, then ANONYMOUS_REGISTER is tested as before.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1658
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1659 Configuring the links in the web header is now easier too. The following
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1660 variables have been added to the classic instance_config.py::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1661
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1662 HEADER_INDEX_LINKS - defines the "index" links to be made available
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1663 HEADER_ADD_LINKS - defines the "add" links
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1664 DEFAULT_INDEX - specifies the index view for DEFAULT
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1665 UNASSIGNED_INDEX - specifies the index view for UNASSIGNED
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1666 USER_INDEX - specifies the index view for USER
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1667
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1668 See the <roundup source>/roundup/templates/classic/instance_config.py for more
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1669 information - including how the variables are to be set up. Most users will
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1670 just be able to copy the variables from the source to their instance home. If
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1671 you've modified the header by changing the source of the interfaces.py file in
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1672 the instance home, you'll need to remove that customisation and move it into
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1673 the appropriate variables in instance_config.py.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1674
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1675 The extended schema has similar variables added too - see the source for more
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1676 info.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1677
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1678 0.4.1 Alternate E-Mail Addresses
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1679 --------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1680
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1681 If you add the property "alternate_addresses" to your user class, your users
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1682 will be able to register alternate email addresses that they may use to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1683 communicate with roundup as. All email from roundup will continue to be sent
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1684 to their primary address.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1685
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1686 If you have not edited the dbinit.py file in your instance home directory,
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1687 you may simply copy the new dbinit.py file from the core code. If you used
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1688 the classic schema, the interfaces file is in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1689
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1690 <roundup source>/roundup/templates/classic/dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1691
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1692 If you used the extended schema, the file is in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1693
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1694 <roundup source>/roundup/templates/extended/dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1695
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1696 If you have modified your dbinit.py file, you need to edit the dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1697 file in your instance home directory. Find the lines which define the user
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1698 class::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1699
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1700 user = Class(db, "msg",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1701 username=String(), password=Password(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1702 address=String(), realname=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1703 phone=String(), organisation=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1704 alternate_addresses=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1705
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1706 You will also want to add the property to the user's details page. The
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1707 template for this is the "user.item" file in your instance home "html"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1708 directory. Similar to above, you may copy the file from the roundup source if
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1709 you haven't modified it. Otherwise, add the following to the template::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1710
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1711 <display call="multiline('alternate_addresses')">
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1712
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1713 with appropriate labelling etc. See the standard template for an idea.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1714
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1715
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1716
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1717 Migrating from 0.3.x to 0.4.0
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1718 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1719
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1720 0.4.0 Message-ID and In-Reply-To addition
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1721 -----------------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1722 0.4.0 adds the tracking of messages by message-id and allows threading
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1723 using in-reply-to. Most e-mail clients support threading using this
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1724 feature, and we hope to add support for it to the web gateway. If you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1725 have not edited the dbinit.py file in your instance home directory, you may
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1726 simply copy the new dbinit.py file from the core code. If you used the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1727 classic schema, the interfaces file is in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1728
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1729 <roundup source>/roundup/templates/classic/dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1730
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1731 If you used the extended schema, the file is in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1732
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1733 <roundup source>/roundup/templates/extended/dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1734
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1735 If you have modified your dbinit.py file, you need to edit the dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1736 file in your instance home directory. Find the lines which define the msg
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1737 class::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1738
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1739 msg = FileClass(db, "msg",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1740 author=Link("user"), recipients=Multilink("user"),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1741 date=Date(), summary=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1742 files=Multilink("file"))
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1743
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1744 and add the messageid and inreplyto properties like so::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1745
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1746 msg = FileClass(db, "msg",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1747 author=Link("user"), recipients=Multilink("user"),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1748 date=Date(), summary=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1749 files=Multilink("file"),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1750 messageid=String(), inreplyto=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1751
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1752 Also, configuration is being cleaned up. This means that your dbinit.py will
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1753 also need to be changed in the open function. If you haven't changed your
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1754 dbinit.py, the above copy will be enough. If you have, you'll need to change
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1755 the line (round line 50)::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1756
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1757 db = Database(instance_config.DATABASE, name)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1758
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1759 to::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1760
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1761 db = Database(instance_config, name)
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1762
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1763
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1764 0.4.0 Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1765 --------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1766 ``TRACKER_NAME`` and ``EMAIL_SIGNATURE_POSITION`` have been added to the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1767 instance_config.py. The simplest solution is to copy the default values
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1768 from template in the core source.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1769
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1770 The mail gateway now checks ``ANONYMOUS_REGISTER`` to see if unknown users
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1771 are to be automatically registered with the tracker. If it is set to "deny"
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1772 then unknown users will not have access. If it is set to "allow" they will be
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1773 automatically registered with the tracker.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1774
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1775
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1776 0.4.0 CGI script roundup.cgi
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1777 ----------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1778 The CGI script has been updated with some features and a bugfix, so you should
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1779 copy it from the roundup cgi-bin source directory again. Make sure you update
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1780 the ROUNDUP_INSTANCE_HOMES after the copy.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1781
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1782
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1783 0.4.0 Nosy reactor
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1784 ------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1785 The nosy reactor has also changed - copy the nosyreactor.py file from the core
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1786 source::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1787
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1788 <roundup source>/roundup/templates/<template>/detectors/nosyreactor.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1789
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1790 to your instance home "detectors" directory.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1791
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1792
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1793 0.4.0 HTML templating
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1794 ---------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1795 The field() function was incorrectly implemented - links and multilinks now
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1796 display as text fields when rendered using field(). To display a menu (drop-
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1797 down or select box) you need to use the menu() function.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1798
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1799
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1800
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1801 Migrating from 0.2.x to 0.3.x
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1802 =============================
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1803
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1804 0.3.x Cookie Authentication changes
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1805 -----------------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1806 0.3.0 introduces cookie authentication - you will need to copy the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1807 interfaces.py file from the roundup source to your instance home to enable
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1808 authentication. If you used the classic schema, the interfaces file is in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1809
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1810 <roundup source>/roundup/templates/classic/interfaces.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1811
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1812 If you used the extended schema, the file is in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1813
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1814 <roundup source>/roundup/templates/extended/interfaces.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1815
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1816 If you have modified your interfaces.Client class, you will need to take
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1817 note of the login/logout functionality provided in roundup.cgi_client.Client
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1818 (classic schema) or roundup.cgi_client.ExtendedClient (extended schema) and
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1819 modify your instance code apropriately.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1820
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1821
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1822 0.3.x Password encoding
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1823 -----------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1824 This release also introduces encoding of passwords in the database. If you
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1825 have not edited the dbinit.py file in your instance home directory, you may
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1826 simply copy the new dbinit.py file from the core code. If you used the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1827 classic schema, the interfaces file is in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1828
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1829 <roundup source>/roundup/templates/classic/dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1830
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1831 If you used the extended schema, the file is in::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1832
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1833 <roundup source>/roundup/templates/extended/dbinit.py
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1834
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1835
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1836 If you have modified your dbinit.py file, you may use encoded passwords:
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1837
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1838 1. Edit the dbinit.py file in your instance home directory
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1839 a. At the first code line of the open() function::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1840
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1841 from roundup.hyperdb import String, Date, Link, Multilink
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1842
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1843 alter to include Password, as so::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1844
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1845 from roundup.hyperdb import String, Password, Date, Link, Multilink
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1846
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1847 b. Where the password property is defined (around line 66)::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1848
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1849 user = Class(db, "user",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1850 username=String(), password=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1851 address=String(), realname=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1852 phone=String(), organisation=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1853 user.setkey("username")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1854
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1855 alter the "password=String()" to "password=Password()"::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1856
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1857 user = Class(db, "user",
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1858 username=String(), password=Password(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1859 address=String(), realname=String(),
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1860 phone=String(), organisation=String())
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1861 user.setkey("username")
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1862
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1863 2. Any existing passwords in the database will remain cleartext until they
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1864 are edited. It is recommended that at a minimum the admin password be
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1865 changed immediately::
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1866
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1867 roundup-admin -i <instance home> set user1 password=<new password>
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1868
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1869
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1870 0.3.x Configuration
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1871 -------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1872 FILTER_POSITION, ANONYMOUS_ACCESS, ANONYMOUS_REGISTER have been added to
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1873 the instance_config.py. Simplest solution is to copy the default values from
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1874 template in the core source.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1875
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1876 MESSAGES_TO_AUTHOR has been added to the IssueClass in dbinit.py. Set to 'yes'
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1877 to send nosy messages to the author. Default behaviour is to not send nosy
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1878 messages to the author. You will need to add MESSAGES_TO_AUTHOR to your
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1879 dbinit.py in your instance home.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1880
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1881
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1882 0.3.x CGI script roundup.cgi
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1883 ----------------------------
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1884 There have been some structural changes to the roundup.cgi script - you will
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1885 need to install it again from the cgi-bin directory of the source
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1886 distribution. Make sure you update the ROUNDUP_INSTANCE_HOMES after the
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1887 copy.
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1888
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1889 .. _administration guide: admin_guide.html
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1890 .. _customisation documentation: customizing.html
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1891 .. _main upgrading document: upgrading.html
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1892 .. _security documentation: security-history.html
194093011cb7 Move upgrade directions for version < 1.5.0 to history document
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1893 .. _Software Upgrade: admin_guide.html#software-upgrade
Roundup Issue Tracker: http://roundup-tracker.org/