File: upgrading.html

package info (click to toggle)
roundup 1.2.1-10%2Betch1
links: PTS
area: main
in suites: etch
size: 4,764 kB
ctags: 3,756
sloc: python: 30,296; sh: 1,497; perl: 23; makefile: 22
file content (1652 lines) | stat: -rw-r--r-- 81,299 bytes
parent folder | download | duplicates (2)
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>Upgrading to newer versions of Roundup</title>
<style type="text/css">

/*
:Author: David Goodger
:Contact: goodger@users.sourceforge.net
:Date: $Date$
:Revision: $Revision$
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin-left: 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left {
  clear: left }

img.align-right {
  clear: right }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font-family: serif ;
  font-size: 100% }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em ;
  background-color: #eeeeee }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

tt.docutils {
  background-color: #eeeeee }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="upgrading-to-newer-versions-of-roundup">
<h1 class="title">Upgrading to newer versions of Roundup</h1>
<p>Please read each section carefully and edit your tracker home files
accordingly. Note that there is information about upgrade procedures in the
<a class="reference" href="admin_guide.html">administration guide</a>.</p>
<p>If a specific version transition isn't mentioned here (eg. 0.6.7 to 0.6.8)
then you don't need to do anything. If you're upgrading from 0.5.6 to
0.6.8 though, you'll need to check the &quot;0.5 to 0.6&quot; and &quot;0.6.x to 0.6.3&quot;
steps.</p>
<div class="contents topic">
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
<ul class="simple">
<li><a class="reference" href="#migrating-from-1-1-2-to-1-x-x" id="id12" name="id12">Migrating from 1.1.2 to 1.X.X</a><ul>
<li><a class="reference" href="#x-x-sorting-and-grouping-by-multiple-properties" id="id13" name="id13">1.X.X Sorting and grouping by multiple properties</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-1-1-0-to-1-1-1" id="id14" name="id14">Migrating from 1.1.0 to 1.1.1</a><ul>
<li><a class="reference" href="#clear-this-message" id="id15" name="id15">1.1.1 &quot;Clear this message&quot;</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-1-0-x-to-1-1-0" id="id16" name="id16">Migrating from 1.0.x to 1.1.0</a><ul>
<li><a class="reference" href="#login-for-session-only" id="id17" name="id17">1.1 Login &quot;For Session Only&quot;</a></li>
<li><a class="reference" href="#query-display-name" id="id18" name="id18">1.1 Query Display Name</a></li>
<li><a class="reference" href="#id1" id="id19" name="id19">1.1 &quot;Clear this message&quot;</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-8-x-to-1-0" id="id20" name="id20">Migrating from 0.8.x to 1.0</a><ul>
<li><a class="reference" href="#new-query-permissions" id="id21" name="id21">1.0 New Query Permissions</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-8-0-to-0-8-3" id="id22" name="id22">Migrating from 0.8.0 to 0.8.3</a><ul>
<li><a class="reference" href="#nosy-handling-changes" id="id23" name="id23">0.8.3 Nosy Handling Changes</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-7-1-to-0-8-0" id="id24" name="id24">Migrating from 0.7.1 to 0.8.0</a><ul>
<li><a class="reference" href="#backend-changes" id="id25" name="id25">0.8.0 Backend changes</a></li>
<li><a class="reference" href="#api-changes" id="id26" name="id26">0.8.0 API changes</a></li>
<li><a class="reference" href="#new-tracker-layout" id="id27" name="id27">0.8.0 New tracker layout</a></li>
<li><a class="reference" href="#permissions-changes" id="id28" name="id28">0.8.0 Permissions Changes</a></li>
<li><a class="reference" href="#use-of-templatingutils" id="id29" name="id29">0.8.0 Use of TemplatingUtils</a></li>
<li><a class="reference" href="#logging-configuration" id="id30" name="id30">0.8.0 Logging Configuration</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-7-2-to-0-7-3" id="id31" name="id31">Migrating from 0.7.2 to 0.7.3</a><ul>
<li><a class="reference" href="#configuration" id="id32" name="id32">0.7.3 Configuration</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-7-0-to-0-7-2" id="id33" name="id33">Migrating from 0.7.0 to 0.7.2</a><ul>
<li><a class="reference" href="#default-timezone-is-now-required" id="id34" name="id34">0.7.2 DEFAULT_TIMEZONE is now required</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-7-0-to-0-7-1" id="id35" name="id35">Migrating from 0.7.0 to 0.7.1</a><ul>
<li><a class="reference" href="#permission-assignments" id="id36" name="id36">0.7.1 Permission assignments</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-6-to-0-7" id="id37" name="id37">Migrating from 0.6 to 0.7</a><ul>
<li><a class="reference" href="#id2" id="id38" name="id38">0.7.0 Permission assignments</a></li>
<li><a class="reference" href="#getting-the-current-user-id" id="id39" name="id39">0.7.0 Getting the current user id</a></li>
<li><a class="reference" href="#zroundup-changes" id="id40" name="id40">0.7.0 ZRoundup changes</a></li>
<li><a class="reference" href="#edit-collision-detection" id="id41" name="id41">0.7.0 Edit collision detection</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-6-x-to-0-6-3" id="id42" name="id42">Migrating from 0.6.x to 0.6.3</a><ul>
<li><a class="reference" href="#id3" id="id43" name="id43">0.6.3 Configuration</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-5-to-0-6" id="id44" name="id44">Migrating from 0.5 to 0.6</a><ul>
<li><a class="reference" href="#id4" id="id45" name="id45">0.6.0 Configuration</a></li>
<li><a class="reference" href="#templating-changes" id="id46" name="id46">0.6.0 Templating changes</a></li>
<li><a class="reference" href="#form-handling-changes" id="id47" name="id47">0.6.0 Form handling changes</a></li>
<li><a class="reference" href="#multilingual-character-set-support" id="id48" name="id48">0.6.0 Multilingual character set support</a></li>
<li><a class="reference" href="#user-timezone-support" id="id49" name="id49">0.6.0 User timezone support</a></li>
<li><a class="reference" href="#search-page-structure" id="id50" name="id50">0.6.0 Search page structure</a></li>
<li><a class="reference" href="#notes-for-metakit-backend-users" id="id51" name="id51">0.6.0 Notes for metakit backend users</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-4-x-to-0-5-0" id="id52" name="id52">Migrating from 0.4.x to 0.5.0</a><ul>
<li><a class="reference" href="#id7" id="id53" name="id53">0.5.0 Configuration</a></li>
<li><a class="reference" href="#schema-specification" id="id54" name="id54">0.5.0 Schema Specification</a><ul>
<li><a class="reference" href="#database-backend-changes" id="id55" name="id55">0.5.0 Database backend changes</a></li>
<li><a class="reference" href="#journalling-changes" id="id56" name="id56">0.5.0 Journalling changes</a></li>
<li><a class="reference" href="#user-schema-changes" id="id57" name="id57">0.5.0 User schema changes</a></li>
<li><a class="reference" href="#security-settings" id="id58" name="id58">0.5.0 Security Settings</a></li>
<li><a class="reference" href="#user-changes" id="id59" name="id59">0.5.0 User changes</a></li>
</ul>
</li>
<li><a class="reference" href="#cgi-interface-changes" id="id60" name="id60">0.5.0 CGI interface changes</a></li>
<li><a class="reference" href="#html-templating" id="id61" name="id61">0.5.0 HTML templating</a></li>
<li><a class="reference" href="#detectors" id="id62" name="id62">0.5.0 Detectors</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-4-1-to-0-4-2" id="id63" name="id63">Migrating from 0.4.1 to 0.4.2</a><ul>
<li><a class="reference" href="#id8" id="id64" name="id64">0.4.2 Configuration</a></li>
<li><a class="reference" href="#changes-to-detectors" id="id65" name="id65">0.4.2 Changes to detectors</a></li>
<li><a class="reference" href="#html-templating-changes" id="id66" name="id66">0.4.2 HTML templating changes</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-4-0-to-0-4-1" id="id67" name="id67">Migrating from 0.4.0 to 0.4.1</a><ul>
<li><a class="reference" href="#files-storage" id="id68" name="id68">0.4.1 Files storage</a></li>
<li><a class="reference" href="#id9" id="id69" name="id69">0.4.1 Configuration</a></li>
<li><a class="reference" href="#alternate-e-mail-addresses" id="id70" name="id70">0.4.1 Alternate E-Mail Addresses</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-3-x-to-0-4-0" id="id71" name="id71">Migrating from 0.3.x to 0.4.0</a><ul>
<li><a class="reference" href="#message-id-and-in-reply-to-addition" id="id72" name="id72">0.4.0 Message-ID and In-Reply-To addition</a></li>
<li><a class="reference" href="#id10" id="id73" name="id73">0.4.0 Configuration</a></li>
<li><a class="reference" href="#cgi-script-roundup-cgi" id="id74" name="id74">0.4.0 CGI script roundup.cgi</a></li>
<li><a class="reference" href="#nosy-reactor" id="id75" name="id75">0.4.0 Nosy reactor</a></li>
<li><a class="reference" href="#id11" id="id76" name="id76">0.4.0 HTML templating</a></li>
</ul>
</li>
<li><a class="reference" href="#migrating-from-0-2-x-to-0-3-x" id="id77" name="id77">Migrating from 0.2.x to 0.3.x</a><ul>
<li><a class="reference" href="#x-cookie-authentication-changes" id="id78" name="id78">0.3.x Cookie Authentication changes</a></li>
<li><a class="reference" href="#x-password-encoding" id="id79" name="id79">0.3.x Password encoding</a></li>
<li><a class="reference" href="#x-configuration" id="id80" name="id80">0.3.x Configuration</a></li>
<li><a class="reference" href="#x-cgi-script-roundup-cgi" id="id81" name="id81">0.3.x CGI script roundup.cgi</a></li>
</ul>
</li>
</ul>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id12" id="migrating-from-1-1-2-to-1-x-x" name="migrating-from-1-1-2-to-1-x-x">Migrating from 1.1.2 to 1.X.X</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id13" id="x-x-sorting-and-grouping-by-multiple-properties" name="x-x-sorting-and-grouping-by-multiple-properties">1.X.X Sorting and grouping by multiple properties</a></h2>
<p>Starting with this version, sorting and grouping by multiple properties
is possible. This means that request.sort and request.group are now
lists. This is reflected in several places:</p>
<blockquote>
<ul>
<li><p class="first"><tt class="docutils literal"><span class="pre">renderWith</span></tt> now has list attributes for <tt class="docutils literal"><span class="pre">sort</span></tt> and <tt class="docutils literal"><span class="pre">group</span></tt>,
where you previously wrote:</p>
<pre class="literal-block">
renderWith(... sort=('-', 'activity'), group=('+', 'priority')
</pre>
<p>you write now:</p>
<pre class="literal-block">
renderWith(... sort=[('-', 'activity')], group=[('+', 'priority')]
</pre>
</li>
<li><p class="first">In templates that permit to edit sorting/grouping, request.sort and
request.group are (possibly empty) lists. You can now sort and group
by multiple attributes. For an example, see the classic template. You
may want search for the variable <tt class="docutils literal"><span class="pre">n_sort</span></tt> which can be set to the
number of sort/group properties.</p>
</li>
<li><p class="first">Templates that diplay new headlines for each group of items with
equal group properties can now use the modified <tt class="docutils literal"><span class="pre">batch.propchanged</span></tt>
method that can take several properties which are checked for
changes. See the example in the classic template which makes use of
<tt class="docutils literal"><span class="pre">batch.propchanged</span></tt>.</p>
</li>
</ul>
</blockquote>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id14" id="migrating-from-1-1-0-to-1-1-1" name="migrating-from-1-1-0-to-1-1-1">Migrating from 1.1.0 to 1.1.1</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id15" id="clear-this-message" name="clear-this-message">1.1.1 &quot;Clear this message&quot;</a></h2>
<p>In 1.1.1, the standard <tt class="docutils literal"><span class="pre">page.html</span></tt> template includes a &quot;clear this message&quot;
link in the green &quot;ok&quot; message bar that appears after a successful edit
(or other) action.</p>
<p>To include this in your tracker, change the following in your <tt class="docutils literal"><span class="pre">page.html</span></tt>
template:</p>
<pre class="literal-block">
&lt;p tal:condition=&quot;options/ok_message | nothing&quot; class=&quot;ok-message&quot;
   tal:repeat=&quot;m options/ok_message&quot; tal:content=&quot;structure m&quot;&gt;error&lt;/p&gt;
</pre>
<p>to be:</p>
<pre class="literal-block">
&lt;p tal:condition=&quot;options/ok_message | nothing&quot; class=&quot;ok-message&quot;&gt;
  &lt;span tal:repeat=&quot;m options/ok_message&quot;
     tal:content=&quot;structure string:$m &lt;br/ &gt; &quot; /&gt;
   &lt;a class=&quot;form-small&quot; tal:attributes=&quot;href request/current_url&quot;
      i18n:translate=&quot;&quot;&gt;clear this message&lt;/a&gt;
&lt;/p&gt;
</pre>
<p>If you implemented the &quot;clear this message&quot; in your 1.1.0 tracker, then you
should change it to the above and it will work much better!</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id16" id="migrating-from-1-0-x-to-1-1-0" name="migrating-from-1-0-x-to-1-1-0">Migrating from 1.0.x to 1.1.0</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id17" id="login-for-session-only" name="login-for-session-only">1.1 Login &quot;For Session Only&quot;</a></h2>
<p>In 1.1, web logins are alive for the length of a session only, <em>unless</em> you
add the following to the login form in your tracker's <tt class="docutils literal"><span class="pre">page.html</span></tt>:</p>
<pre class="literal-block">
&lt;input type=&quot;checkbox&quot; name=&quot;remember&quot; id=&quot;remember&quot;&gt;
&lt;label for=&quot;remember&quot; i18n:translate=&quot;&quot;&gt;Remember me?&lt;/label&gt;&lt;br&gt;
</pre>
<p>See the classic tracker <tt class="docutils literal"><span class="pre">page.html</span></tt> if you're unsure where this should
go.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id18" id="query-display-name" name="query-display-name">1.1 Query Display Name</a></h2>
<p>The <tt class="docutils literal"><span class="pre">dispname</span></tt> web variable has been renamed <tt class="docutils literal"><span class="pre">&#64;dispname</span></tt> to avoid
clashing with other variables of the same name. If you are using the
display name feature, you will need to edit your tracker's <tt class="docutils literal"><span class="pre">page.html</span></tt>
and <tt class="docutils literal"><span class="pre">issue.index.html</span></tt> pages to change <tt class="docutils literal"><span class="pre">dispname</span></tt> to <tt class="docutils literal"><span class="pre">&#64;dispname</span></tt>.</p>
<p>A side-effect of this change is that the renderWith method used in the
<tt class="docutils literal"><span class="pre">home.html</span></tt> page may now take a dispname argument.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id19" id="id1" name="id1">1.1 &quot;Clear this message&quot;</a></h2>
<p>In 1.1, the standard <tt class="docutils literal"><span class="pre">page.html</span></tt> template includes a &quot;clear this message&quot;
link in the green &quot;ok&quot; message bar that appears after a successful edit
(or other) action.</p>
<p>To include this in your tracker, change the following in your <tt class="docutils literal"><span class="pre">page.html</span></tt>
template:</p>
<pre class="literal-block">
&lt;p tal:condition=&quot;options/ok_message | nothing&quot; class=&quot;ok-message&quot;
   tal:repeat=&quot;m options/ok_message&quot; tal:content=&quot;structure m&quot;&gt;error&lt;/p&gt;
</pre>
<p>to be:</p>
<pre class="literal-block">
&lt;p tal:condition=&quot;options/ok_message | nothing&quot; class=&quot;ok-message&quot;&gt;
  &lt;span tal:repeat=&quot;m options/ok_message&quot;
     tal:content=&quot;structure string:$m &lt;br/ &gt; &quot; /&gt;
   &lt;a class=&quot;form-small&quot; tal:attributes=&quot;href string:issue${context/id}&quot;
      i18n:translate=&quot;&quot;&gt;clear this message&lt;/a&gt;
&lt;/p&gt;
</pre>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id20" id="migrating-from-0-8-x-to-1-0" name="migrating-from-0-8-x-to-1-0">Migrating from 0.8.x to 1.0</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id21" id="new-query-permissions" name="new-query-permissions">1.0 New Query Permissions</a></h2>
<p>New permissions are defined for query editing and viewing. To include these
in your tracker, you need to add these lines to your tracker's
<tt class="docutils literal"><span class="pre">schema.py</span></tt>:</p>
<pre class="literal-block">
# Users should be able to edit and view their own queries. They should also
# be able to view any marked as not private. They should not be able to
# edit others' queries, even if they're not private
def view_query(db, userid, itemid):
    private_for = db.query.get(itemid, 'private_for')
    if not private_for: return True
    return userid == private_for
def edit_query(db, userid, itemid):
    return userid == db.query.get(itemid, 'creator')
p = db.security.addPermission(name='View', klass='query', check=view_query,
    description=&quot;User is allowed to view their own and public queries&quot;)
db.security.addPermissionToRole('User', p)
p = db.security.addPermission(name='Edit', klass='query', check=edit_query,
    description=&quot;User is allowed to edit their queries&quot;)
db.security.addPermissionToRole('User', p)
p = db.security.addPermission(name='Create', klass='query',
    description=&quot;User is allowed to create queries&quot;)
db.security.addPermissionToRole('User', p)
</pre>
<p>and then remove 'query' from the line:</p>
<pre class="literal-block">
# Assign the access and edit Permissions for issue, file and message
# to regular users now
for cl in 'issue', 'file', 'msg', 'query', 'keyword':
</pre>
<p>so it looks like:</p>
<pre class="literal-block">
for cl in 'issue', 'file', 'msg', 'keyword':
</pre>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id22" id="migrating-from-0-8-0-to-0-8-3" name="migrating-from-0-8-0-to-0-8-3">Migrating from 0.8.0 to 0.8.3</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id23" id="nosy-handling-changes" name="nosy-handling-changes">0.8.3 Nosy Handling Changes</a></h2>
<p>A change was made to fix a bug in the <tt class="docutils literal"><span class="pre">nosyreaction.py</span></tt> standard
detector. To incorporate this fix in your trackers, you will need to copy
the <tt class="docutils literal"><span class="pre">nosyreaction.py</span></tt> file from the <tt class="docutils literal"><span class="pre">templates/classic/detectors</span></tt>
directory of the source to your tracker's <tt class="docutils literal"><span class="pre">templates</span></tt> directory.</p>
<p>If you have modified the <tt class="docutils literal"><span class="pre">nosyreaction.py</span></tt> file from the standard
version, you will need to roll your changes into the new file.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id24" id="migrating-from-0-7-1-to-0-8-0" name="migrating-from-0-7-1-to-0-8-0">Migrating from 0.7.1 to 0.8.0</a></h1>
<p>You <em>must</em> fully uninstall previous Roundup version before installing
Roundup 0.8.0.  If you don't do that, <tt class="docutils literal"><span class="pre">roundup-admin</span> <span class="pre">install</span></tt>
command may fail to function properly.</p>
<div class="section">
<h2><a class="toc-backref" href="#id25" id="backend-changes" name="backend-changes">0.8.0 Backend changes</a></h2>
<p>Backends 'bsddb' and 'bsddb3' are removed.  If you are using one of these,
you <em>must</em> migrate to another backend before upgrading.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id26" id="api-changes" name="api-changes">0.8.0 API changes</a></h2>
<p>Class.safeget() was removed from the API. Test your item ids before calling
Class.get() instead.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id27" id="new-tracker-layout" name="new-tracker-layout">0.8.0 New tracker layout</a></h2>
<p>The <tt class="docutils literal"><span class="pre">config.py</span></tt> file has been replaced by <tt class="docutils literal"><span class="pre">config.ini</span></tt>. You may use the
roundup-admin command &quot;genconfig&quot; to generate a new config file:</p>
<pre class="literal-block">
roundup-admin genconfig &lt;tracker home&gt;/config.ini
</pre>
<p>and modify the values therein based on the contents of your old config.py.
In most cases, the names of the config variables are the same.</p>
<p>The <tt class="docutils literal"><span class="pre">select_db.py</span></tt> file has been replaced by a file in the <tt class="docutils literal"><span class="pre">db</span></tt>
directory called <tt class="docutils literal"><span class="pre">backend_name</span></tt>. As you might guess, this file contains
just the name of the backend. To figure what the contents of yours should
be, use the following table:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="56%" />
<col width="44%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head"><tt class="docutils literal"><span class="pre">select_db.py</span></tt> contents</th>
<th class="head"><tt class="docutils literal"><span class="pre">backend_name</span></tt> contents</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>from back_anydbm import ...</td>
<td>anydbm</td>
</tr>
<tr><td>from back_metakit import ...</td>
<td>metakit</td>
</tr>
<tr><td>from back_sqlite import ...</td>
<td>sqlite</td>
</tr>
<tr><td>from back_mysql import ...</td>
<td>mysql</td>
</tr>
<tr><td>from back_postgresql import ...</td>
<td>postgresql</td>
</tr>
</tbody>
</table>
</blockquote>
<p>The <tt class="docutils literal"><span class="pre">dbinit.py</span></tt> file has been split into two new files,
<tt class="docutils literal"><span class="pre">initial_data.py</span></tt> and <tt class="docutils literal"><span class="pre">schema.py</span></tt>. The contents of this file are:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">initial_data.py</span></tt></dt>
<dd>You don't need one of these as your tracker is already initialised.</dd>
<dt><tt class="docutils literal"><span class="pre">schema.py</span></tt></dt>
<dd><p class="first">Copy the body of the <tt class="docutils literal"><span class="pre">def</span> <span class="pre">open(name=None)</span></tt> function from your old
tracker's <tt class="docutils literal"><span class="pre">dbinit.py</span></tt> file to this file. As the lines you're copying
aren't part of a function definition anymore, one level of indentation
needs to be removed (remove only the leading four spaces on each
line).</p>
<p class="last">The first few lines -- those starting with <tt class="docutils literal"><span class="pre">from</span> <span class="pre">roundup.hyperdb</span>
<span class="pre">import</span> <span class="pre">...</span></tt> and the <tt class="docutils literal"><span class="pre">db</span> <span class="pre">=</span> <span class="pre">Database(config,</span> <span class="pre">name)</span></tt> line -- don't
need to be copied. Neither do the last few lines -- those starting
with <tt class="docutils literal"><span class="pre">import</span> <span class="pre">detectors</span></tt>, down to <tt class="docutils literal"><span class="pre">return</span> <span class="pre">db</span></tt> inclusive.</p>
</dd>
</dl>
<p>You may remove the <tt class="docutils literal"><span class="pre">__init__.py</span></tt> module from the &quot;detectors&quot; directory as
it is no longer used.</p>
<p>There's a new way to write extension code for Roundup - the old
<tt class="docutils literal"><span class="pre">interfaces.py</span></tt> file will be ignored. See the <a class="reference" href="customizing.html">customisation
documentation</a> for information about how extensions are now written.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id28" id="permissions-changes" name="permissions-changes">0.8.0 Permissions Changes</a></h2>
<p>The creation of a new item in the user interfaces is now controlled by the
&quot;Create&quot; Permission. You will need to add an assignment of this Permission
to your users who are allowed to create items. The most common form of this
is the following in your <tt class="docutils literal"><span class="pre">schema.py</span></tt> added just under the current
assignation of the Edit Permission:</p>
<pre class="literal-block">
for cl in 'issue', 'file', 'msg', 'query', 'keyword':
    p = db.security.getPermission('Create', cl)
    db.security.addPermissionToRole('User', p)
</pre>
<p>You will need to explicitly let anonymous users access the web interface so
that regular users are able to see the login form. Note that almost all
trackers will need this Permission. The only situation where it's not
required is in a tracker that uses an HTTP Basic Authenticated front-end.
It's enabled by adding to your <tt class="docutils literal"><span class="pre">schema.py</span></tt>:</p>
<pre class="literal-block">
p = db.security.getPermission('Web Access')
db.security.addPermissionToRole('Anonymous', p)
</pre>
<p>Finally, you will need to enable permission for your users to edit their
own details by adding the following to <tt class="docutils literal"><span class="pre">schema.py</span></tt>:</p>
<pre class="literal-block">
# Users should be able to edit their own details. Note that this
# permission is limited to only the situation where the Viewed or
# Edited item is their own.
def own_record(db, userid, itemid):
    '''Determine whether the userid matches the item being accessed.'''
    return userid == itemid
p = db.security.addPermission(name='View', klass='user', check=own_record,
    description=&quot;User is allowed to view their own user details&quot;)
p = db.security.addPermission(name='Edit', klass='user', check=own_record,
    description=&quot;User is allowed to edit their own user details&quot;)
db.security.addPermissionToRole('User', p)
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id29" id="use-of-templatingutils" name="use-of-templatingutils">0.8.0 Use of TemplatingUtils</a></h2>
<p>If you used custom python functions in TemplatingUtils, they must
be moved from interfaces.py to a new file in the <tt class="docutils literal"><span class="pre">extensions</span></tt> directory.</p>
<p>Each Function that should be available through TAL needs to be defined
as a toplevel function in the newly created file. Furthermore you
add an inititialization function, that registers the functions with the
tracker.</p>
<p>If you find this too tedious, donfu wrote an automatic init function that
takes an existing TemplatingUtils class, and registers all class methods
that do not start with an underscore. The following hack should be placed
in the <tt class="docutils literal"><span class="pre">extensions</span></tt> directory alongside other extensions:</p>
<pre class="literal-block">
class TemplatingUtils:
     # copy from interfaces.py

def init(tracker):
     util = TemplatingUtils()

     def setClient(tu):
         util.client = tu.client
         return util

     def execUtil(name):
         return lambda tu, *args, **kwargs: \
                 getattr(setClient(tu), name)(*args, **kwargs)

     for name in dir(util):
         if callable(getattr(util, name)) and not name.startswith('_'):
              tracker.registerUtil(name, execUtil(name))
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id30" id="logging-configuration" name="logging-configuration">0.8.0 Logging Configuration</a></h2>
<p>See the <a class="reference" href="admin_guide.html">administration guide</a> for information about configuring the new
logging implemented in 0.8.0.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id31" id="migrating-from-0-7-2-to-0-7-3" name="migrating-from-0-7-2-to-0-7-3">Migrating from 0.7.2 to 0.7.3</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id32" id="configuration" name="configuration">0.7.3 Configuration</a></h2>
<p>If you choose, you may specify the directory from which static files are
served (those which use the URL component <tt class="docutils literal"><span class="pre">&#64;&#64;file</span></tt>). Currently the
directory defaults to the <tt class="docutils literal"><span class="pre">TEMPLATES</span></tt> configuration variable. You may
define a new variable, <tt class="docutils literal"><span class="pre">STATIC_FILES</span></tt> which overrides this value for
static files.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id33" id="migrating-from-0-7-0-to-0-7-2" name="migrating-from-0-7-0-to-0-7-2">Migrating from 0.7.0 to 0.7.2</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id34" id="default-timezone-is-now-required" name="default-timezone-is-now-required">0.7.2 DEFAULT_TIMEZONE is now required</a></h2>
<p>The DEFAULT_TIMEZONE configuration variable is now required. Add the
following to your tracker's <tt class="docutils literal"><span class="pre">config.py</span></tt> file:</p>
<pre class="literal-block">
# You may specify a different default timezone, for use when users do not
# choose their own in their settings.
DEFAULT_TIMEZONE = 0            # specify as numeric hour offest
</pre>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id35" id="migrating-from-0-7-0-to-0-7-1" name="migrating-from-0-7-0-to-0-7-1">Migrating from 0.7.0 to 0.7.1</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id36" id="permission-assignments" name="permission-assignments">0.7.1 Permission assignments</a></h2>
<p>If you allow anonymous access to your tracker, you might need to assign
some additional View (or Edit if your tracker is that open) permissions
to the &quot;anonymous&quot; user. To do so, find the code in your <tt class="docutils literal"><span class="pre">dbinit.py</span></tt> that
says:</p>
<pre class="literal-block">
for cl in 'issue', 'file', 'msg', 'query', 'keyword':
    p = db.security.getPermission('View', cl)
    db.security.addPermissionToRole('User', p)
    p = db.security.getPermission('Edit', cl)
    db.security.addPermissionToRole('User', p)
for cl in 'priority', 'status':
    p = db.security.getPermission('View', cl)
    db.security.addPermissionToRole('User', p)
</pre>
<p>Add add a line:</p>
<pre class="literal-block">
db.security.addPermissionToRole('Anonymous', p)
</pre>
<p>next to the existing <tt class="docutils literal"><span class="pre">'User'</span></tt> lines for the Permissions you wish to
assign to the anonymous user.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id37" id="migrating-from-0-6-to-0-7" name="migrating-from-0-6-to-0-7">Migrating from 0.6 to 0.7</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id38" id="id2" name="id2">0.7.0 Permission assignments</a></h2>
<p>Due to a change in the rendering of web widgets, permissions are now
checked on Classes where they previously weren't (this is a good thing).</p>
<p>You will need to add some additional Permission assignments for your
regular users, or some displays will break. After the following in your
tracker's <tt class="docutils literal"><span class="pre">dbinit.py</span></tt>:</p>
<pre class="literal-block">
# Assign the access and edit Permissions for issue, file and message
# to regular users now
for cl in 'issue', 'file', 'msg', 'query', 'keyword':
    p = db.security.getPermission('View', cl)
    db.security.addPermissionToRole('User', p)
    p = db.security.getPermission('Edit', cl)
    db.security.addPermissionToRole('User', p)
</pre>
<p>add:</p>
<pre class="literal-block">
for cl in 'priority', 'status':
    p = db.security.getPermission('View', cl)
    db.security.addPermissionToRole('User', p)
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id39" id="getting-the-current-user-id" name="getting-the-current-user-id">0.7.0 Getting the current user id</a></h2>
<p>The Database.curuserid attribute has been removed.</p>
<p>Any code referencing this attribute should be replaced with a
call to Database.getuid().</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id40" id="zroundup-changes" name="zroundup-changes">0.7.0 ZRoundup changes</a></h2>
<p>The templates in your tracker's html directory will need updating if you
wish to use ZRoundup. If you've not modified those files (or some of them),
you may just copy the new versions from the Roundup source in the
templates/classic/html directory.</p>
<p>If you have modified the html files, then you'll need to manually edit them
to change all occurances of special form variables from using the colon &quot;:&quot;
special character to the at &quot;&#64;&quot; special character. That is, variables such
as:</p>
<pre class="literal-block">
:action :required :template :remove:messages ...
</pre>
<p>should become:</p>
<pre class="literal-block">
&#64;action &#64;required &#64;template &#64;remove&#64;messages ...
</pre>
<p>Note that <tt class="docutils literal"><span class="pre">tal:</span></tt> statements are unaffected. So are TAL expression type
prefixes such as <tt class="docutils literal"><span class="pre">python:</span></tt> and <tt class="docutils literal"><span class="pre">string:</span></tt>. Please ask on the
roundup-users mailing list for help if you're unsure.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id41" id="edit-collision-detection" name="edit-collision-detection">0.7.0 Edit collision detection</a></h2>
<p>Roundup now detects collisions with editing in the web interface (that is,
two people editing the same item at the same time).</p>
<p>You must copy the <tt class="docutils literal"><span class="pre">_generic.collision.html</span></tt> file from Roundup source in
the <tt class="docutils literal"><span class="pre">templates/classic/html</span></tt> directory. to your tracker's <tt class="docutils literal"><span class="pre">html</span></tt>
directory.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id42" id="migrating-from-0-6-x-to-0-6-3" name="migrating-from-0-6-x-to-0-6-3">Migrating from 0.6.x to 0.6.3</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id43" id="id3" name="id3">0.6.3 Configuration</a></h2>
<p>You will need to copy the file:</p>
<pre class="literal-block">
templates/classic/detectors/__init__.py
</pre>
<p>to your tracker's <tt class="docutils literal"><span class="pre">detectors</span></tt> directory, replacing the one already there.
This fixes a couple of bugs in that file.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id44" id="migrating-from-0-5-to-0-6" name="migrating-from-0-5-to-0-6">Migrating from 0.5 to 0.6</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id45" id="id4" name="id4">0.6.0 Configuration</a></h2>
<p>Introduced EMAIL_FROM_TAG config variable. This value is inserted into
the From: line of nosy email. If the sending user is &quot;Foo Bar&quot;, the
From: line is usually:</p>
<pre class="literal-block">
&quot;Foo Bar&quot; &lt;issue_tracker&#64;tracker.example&gt;
</pre>
<p>the EMAIL_FROM_TAG goes inside the &quot;Foo Bar&quot; quotes like so:</p>
<pre class="literal-block">
&quot;Foo Bar EMAIL_FROM_TAG&quot; &lt;issue_tracker&#64;tracker.example&gt;
</pre>
<p>I've altered the mechanism in the detectors __init__.py module so that it
doesn't cross-import detectors from other trackers (if you run more than one
in a single roundup-server). This change means that you'll need to copy the
__init__.py from roundup/templates/classic/detectors/__init__.py to your
&lt;tracker home&gt;/detectors/__init__.py. Don't worry, the &quot;classic&quot; __init__ is a
one-size-fits-all, so it'll work even if you've added/removed detectors.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id46" id="templating-changes" name="templating-changes">0.6.0 Templating changes</a></h2>
<p>The <tt class="docutils literal"><span class="pre">user.item</span></tt> template (in the tracker home &quot;templates&quot; directory)
needs to have the following hidden variable added to its form (between the
<tt class="docutils literal"><span class="pre">&lt;form...&gt;</span></tt> and <tt class="docutils literal"><span class="pre">&lt;/form&gt;</span></tt> tags:</p>
<pre class="literal-block">
&lt;input type=&quot;hidden&quot; name=&quot;:template&quot; value=&quot;item&quot;&gt;
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id47" id="form-handling-changes" name="form-handling-changes">0.6.0 Form handling changes</a></h2>
<p>Roundup's form handling capabilities have been significantly expanded. This
should not affect users of 0.5 installations - but if you find you're
getting errors from form submissions, please ask for help on the Roundup
users mailing list:</p>
<blockquote>
<a class="reference" href="http://lists.sourceforge.net/lists/listinfo/roundup-users">http://lists.sourceforge.net/lists/listinfo/roundup-users</a></blockquote>
<p>See the customisation doc section on <a class="reference" href="customizing.html#form-values">Form Values</a> for documentation of the
new form variables possible.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id48" id="multilingual-character-set-support" name="multilingual-character-set-support">0.6.0 Multilingual character set support</a></h2>
<p>Added internationalization support. This is done via encoding all data
stored in roundup database to utf-8 (unicode encoding). To support utf-8 in
web interface you should add the folowing line to your tracker's html/page
and html/_generic.help files inside &lt;head&gt; tag:</p>
<pre class="literal-block">
&lt;meta http-equiv=&quot;Content-Type&quot; content=&quot;text/html; charset=utf-8&quot;&gt;
</pre>
<p>Since latin characters in utf-8 have the same codes as in ASCII table, this
modification is optional for users who use only plain latin characters.</p>
<p>After this modification, you will be able to see and enter any world
character via web interface. Data received via mail interface also converted
to utf-8, however only new messages will be converted. If your roundup
database contains some of non-ASCII characters in one of 8-bit encoding,
they will not be visible in new unicode environment. Some of such data (e.g.
user names, keywords, etc)  can be edited by administrator, the others
(e.g. messages' contents) is not editable via web interface. Currently there
is no tool for converting such data, the only solution is to close
appropriate old issues and create new ones with the same content.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id49" id="user-timezone-support" name="user-timezone-support">0.6.0 User timezone support</a></h2>
<p>From version 0.6.0 roundup supports displaying of Date data in user' local
timezone if he/she has provided timezone information. To make it possible
some modification to tracker's schema and HTML templates are required.
First you must add string property 'timezone' to user class in dbinit.py
like this:</p>
<pre class="literal-block">
user = Class(db, &quot;user&quot;,
                username=String(),   password=Password(),
                address=String(),    realname=String(),
                phone=String(),      organisation=String(),
                alternate_addresses=String(),
                queries=Multilink('query'), roles=String(),
                timezone=String())
</pre>
<p>And second - html interface. Add following lines to
$TRACKER_HOME/html/user.item template:</p>
<pre class="literal-block">
&lt;tr&gt;
 &lt;th&gt;Timezone&lt;/th&gt;
 &lt;td tal:content=&quot;structure context/timezone/field&quot;&gt;timezone&lt;/td&gt;
&lt;/tr&gt;
</pre>
<p>After that all users should be able to provide their timezone information.
Timezone should be a positive or negative integer - offset from GMT.</p>
<p>After providing timezone, roundup will show all dates values, found in web
and mail interfaces in local time. It will also accept any Date info in
local time, convert and store it in GMT.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id50" id="search-page-structure" name="search-page-structure">0.6.0 Search page structure</a></h2>
<p>In order to accomodate query editing the search page has been restructured. If
you want to provide your users with query editing, you should update your
search page using the macros detailed in the customisation doc section
<a class="reference" href="customizing.html#searching-on-categories">Searching on categories</a>.</p>
<p>Also, the url field in the query class no longer starts with a '?'. You'll need
to remove this question mark from the url field to support queries. There's
a script in the &quot;tools&quot; directory called <tt class="docutils literal"><span class="pre">migrate-queries.py</span></tt> that should
automatically change any existing queries for you. As always, make a backup
of your database before running such a script.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id51" id="notes-for-metakit-backend-users" name="notes-for-metakit-backend-users">0.6.0 Notes for metakit backend users</a></h2>
<p>Roundup 0.6.0 introduced searching on ranges of dates and intervals. To
support it, some modifications to interval storing routine were made. So if
your tracker uses metakit backend and your db schema contains intervals
property, searches on that property will not be accurate for db items that
was stored before roundup' upgrade. However all new records should be
searchable on intervals.</p>
<p>It is possible to convert your database to new format: you can export and
import back all your data (consult &quot;Migrating backends&quot; in &quot;Maintenance&quot;
documentation). After this operation all your interval properties should
become searchable.</p>
<p>Users of backends others than metakit should not worry about this issue.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id52" id="migrating-from-0-4-x-to-0-5-0" name="migrating-from-0-4-x-to-0-5-0">Migrating from 0.4.x to 0.5.0</a></h1>
<p>This has been a fairly major revision of Roundup:</p>
<ol class="arabic simple">
<li>Brand new, much more powerful, flexible, tasty and nutritious templating.
Unfortunately, this means all your current templates are useless. Hopefully
the new documentation and examples will be enough to help you make the
transition. Please don't hesitate to ask on roundup-users for help (or
complete conversions if you're completely stuck)!</li>
<li>The database backed got a lot more flexible, allowing Metakit and SQL
databases! The only decent SQL database implemented at present is sqlite,
but others shouldn't be a whole lot more work.</li>
<li>A brand new, highly flexible and much more robust security system including
a system of Permissions, Roles and Role assignments to users. You may now
define your own Permissions that may be checked in CGI transactions.</li>
<li>Journalling has been made less storage-hungry, so has been turned on
by default <em>except</em> for author, recipient and nosy link/unlink events. You
are advised to turn it off in your trackers too.</li>
<li>We've changed the terminology from &quot;instance&quot; to &quot;tracker&quot;, to ease the
learning curve/impact for new users.</li>
<li>Because of the above changes, the tracker configuration has seen some
major changes. See below for the details.</li>
</ol>
<p>Please, <strong>back up your database</strong> before you start the migration process. This
is as simple as copying the &quot;db&quot; directory and all its contents from your
tracker to somewhere safe.</p>
<div class="section">
<h2><a class="toc-backref" href="#id53" id="id7" name="id7">0.5.0 Configuration</a></h2>
<p>First up, rename your <tt class="docutils literal"><span class="pre">instance_config.py</span></tt> file to just <tt class="docutils literal"><span class="pre">config.py</span></tt>.</p>
<p>Then edit your tracker's <tt class="docutils literal"><span class="pre">__init__.py</span></tt> module. It'll currently look
like this:</p>
<pre class="literal-block">
from instance_config import *
try:
    from dbinit import *
except ImportError:
    pass # in installdir (probably :)
from interfaces import *
</pre>
<p>and it needs to be:</p>
<pre class="literal-block">
import config
from dbinit import open, init
from interfaces import Client, MailGW
</pre>
<p>Due to the new templating having a top-level <tt class="docutils literal"><span class="pre">page</span></tt> that defines links for
searching, indexes, adding items etc, the following variables are no longer
used:</p>
<ul class="simple">
<li>HEADER_INDEX_LINKS</li>
<li>HEADER_ADD_LINKS</li>
<li>HEADER_SEARCH_LINKS</li>
<li>SEARCH_FILTERS</li>
<li>DEFAULT_INDEX</li>
<li>UNASSIGNED_INDEX</li>
<li>USER_INDEX</li>
<li>ISSUE_FILTER</li>
</ul>
<p>The new security implementation will require additions to the dbinit module,
but also removes the need for the following tracker config variables:</p>
<ul class="simple">
<li>ANONYMOUS_ACCESS</li>
<li>ANONYMOUS_REGISTER</li>
</ul>
<p>but requires two new variables which define the Roles assigned to users who
register through the web and e-mail interfaces:</p>
<ul class="simple">
<li>NEW_WEB_USER_ROLES</li>
<li>NEW_EMAIL_USER_ROLES</li>
</ul>
<p>in both cases, 'User' is a good initial setting. To emulate
<tt class="docutils literal"><span class="pre">ANONYMOUS_ACCESS='deny'</span></tt>, remove all &quot;View&quot; Permissions from the
&quot;Anonymous&quot; Role. To emulate <tt class="docutils literal"><span class="pre">ANONYMOUS_REGISTER='deny'</span></tt>, remove the &quot;Web
Registration&quot; and/or the &quot;Email Registration&quot; Permission from the &quot;Anonymous&quot;
Role. See the section on customising security in the <a class="reference" href="customizing.html">customisation
documentation</a> for more information.</p>
<p>Finally, the following config variables have been renamed to make more sense:</p>
<ul class="simple">
<li>INSTANCE_HOME -&gt; TRACKER_HOME</li>
<li>INSTANCE_NAME -&gt; TRACKER_NAME</li>
<li>ISSUE_TRACKER_WEB -&gt; TRACKER_WEB</li>
<li>ISSUE_TRACKER_EMAIL -&gt; TRACKER_EMAIL</li>
</ul>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id54" id="schema-specification" name="schema-specification">0.5.0 Schema Specification</a></h2>
<div class="section">
<h3><a class="toc-backref" href="#id55" id="database-backend-changes" name="database-backend-changes">0.5.0 Database backend changes</a></h3>
<p>Your select_db module in your tracker has changed a fair bit. Where it used
to contain:</p>
<pre class="literal-block">
# WARNING: DO NOT EDIT THIS FILE!!!
from roundup.backends.back_anydbm import Database
</pre>
<p>it must now contain:</p>
<pre class="literal-block">
# WARNING: DO NOT EDIT THIS FILE!!!
from roundup.backends.back_anydbm import Database, Class, FileClass, IssueClass
</pre>
<p>Yes, I realise the irony of the &quot;DO NOT EDIT THIS FILE&quot; statement :)
Note the addition of the Class, FileClass, IssueClass imports. These are very
important, as they're going to make the next change work too. You now need to
modify the top of the dbinit module in your tracker from:</p>
<pre class="literal-block">
import instance_config
from roundup import roundupdb
from select_db import Database

from roundup.roundupdb import Class, FileClass

class Database(roundupdb.Database, select_db.Database):
    ''' Creates a hybrid database from:
         . the selected database back-end from select_db
         . the roundup extensions from roundupdb
    '''
    pass

class IssueClass(roundupdb.IssueClass):
    ''' issues need the email information
    '''
    pass
</pre>
<p>to:</p>
<pre class="literal-block">
import config
from select_db import Database, Class, FileClass, IssueClass
</pre>
<p>Yes, remove the Database and IssueClass definitions and those other imports.
They're not needed any more!</p>
<p>Look for places in dbinit.py where <tt class="docutils literal"><span class="pre">instance_config</span></tt> is used too, and
rename them <tt class="docutils literal"><span class="pre">config</span></tt>.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id56" id="journalling-changes" name="journalling-changes">0.5.0 Journalling changes</a></h3>
<p>Journalling has been optimised for storage. Journalling of links has been
turned back on by default. If your tracker has a large user base, you may wish
to turn off journalling of nosy list, message author and message recipient
link and unlink events. You do this by adding <tt class="docutils literal"><span class="pre">do_journal='no'</span></tt> to the Class
initialisation in your dbinit. For example, your <em>msg</em> class initialisation
probably looks like this:</p>
<pre class="literal-block">
msg = FileClass(db, &quot;msg&quot;,
                author=Link(&quot;user&quot;), recipients=Multilink(&quot;user&quot;),
                date=Date(),         summary=String(),
                files=Multilink(&quot;file&quot;),
                messageid=String(),  inreplyto=String())
</pre>
<p>to turn off journalling of author and recipient link events, add
<tt class="docutils literal"><span class="pre">do_journal='no'</span></tt> to the <tt class="docutils literal"><span class="pre">author=Link(&quot;user&quot;)</span></tt> part of the statement,
like so:</p>
<pre class="literal-block">
msg = FileClass(db, &quot;msg&quot;,
                author=Link(&quot;user&quot;, do_journal='no'),
                recipients=Multilink(&quot;user&quot;, do_journal='no'),
                date=Date(),         summary=String(),
                files=Multilink(&quot;file&quot;),
                messageid=String(),  inreplyto=String())
</pre>
<p>Nosy list link event journalling is actually turned off by default now. If you
want to turn it on, change to your issue class' nosy list, change its
definition from:</p>
<pre class="literal-block">
issue = IssueClass(db, &quot;issue&quot;,
                assignedto=Link(&quot;user&quot;), topic=Multilink(&quot;keyword&quot;),
                priority=Link(&quot;priority&quot;), status=Link(&quot;status&quot;))
</pre>
<p>to:</p>
<pre class="literal-block">
issue = IssueClass(db, &quot;issue&quot;, nosy=Multilink(&quot;user&quot;, do_journal='yes'),
                assignedto=Link(&quot;user&quot;), topic=Multilink(&quot;keyword&quot;),
                priority=Link(&quot;priority&quot;), status=Link(&quot;status&quot;))
</pre>
<p>noting that your definition of the nosy Multilink will override the normal one.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id57" id="user-schema-changes" name="user-schema-changes">0.5.0 User schema changes</a></h3>
<p>Users have two more properties, &quot;queries&quot; and &quot;roles&quot;. You'll have something
like this in your dbinit module now:</p>
<pre class="literal-block">
user = Class(db, &quot;user&quot;,
                username=String(),   password=Password(),
                address=String(),    realname=String(),
                phone=String(),      organisation=String(),
                alternate_addresses=String())
user.setkey(&quot;username&quot;)
</pre>
<p>and you'll need to add the new properties and the new &quot;query&quot; class to it
like so:</p>
<pre class="literal-block">
query = Class(db, &quot;query&quot;,
                klass=String(),     name=String(),
                url=String())
query.setkey(&quot;name&quot;)

# Note: roles is a comma-separated string of Role names
user = Class(db, &quot;user&quot;,
                username=String(),   password=Password(),
                address=String(),    realname=String(),
                phone=String(),      organisation=String(),
                alternate_addresses=String(),
                queries=Multilink('query'), roles=String())
user.setkey(&quot;username&quot;)
</pre>
<p>The &quot;queries&quot; property is used to store off the user's favourite database
queries. The &quot;roles&quot; property is explained below in <a class="reference" href="#security-settings">0.5.0 Security
Settings</a>.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id58" id="security-settings" name="security-settings">0.5.0 Security Settings</a></h3>
<p>See the <a class="reference" href="security.html">security documentation</a> for an explanation of how the new security
system works. In a nutshell though, the security is handled as a four step
process:</p>
<ol class="arabic simple">
<li>Permissions are defined as having a name and optionally a hyperdb class
they're specific to,</li>
<li>Roles are defined that have one or more Permissions,</li>
<li>Users are assigned Roles in their &quot;roles&quot; property, and finally</li>
<li>Roundup checks that users have appropriate Permissions at appropriate times
(like editing issues).</li>
</ol>
<p>Your tracker dbinit module's <em>open</em> function now has to define any
Permissions that are specific to your tracker, and also the assignment
of Permissions to Roles. At the moment, your open function
ends with:</p>
<pre class="literal-block">
import detectors
detectors.init(db)

return db
</pre>
<p>and what we need to do is insert some commands that will set up the security
parameters. Right above the <tt class="docutils literal"><span class="pre">import</span> <span class="pre">detectors</span></tt> line, you'll want to insert
these lines:</p>
<pre class="literal-block">
#
# SECURITY SETTINGS
#
# new permissions for this schema
for cl in 'issue', 'file', 'msg', 'user':
    db.security.addPermission(name=&quot;Edit&quot;, klass=cl,
        description=&quot;User is allowed to edit &quot;+cl)
    db.security.addPermission(name=&quot;View&quot;, klass=cl,
        description=&quot;User is allowed to access &quot;+cl)

# Assign the access and edit permissions for issue, file and message
# to regular users now
for cl in 'issue', 'file', 'msg':
    p = db.security.getPermission('View', cl)
    db.security.addPermissionToRole('User', p)
    p = db.security.getPermission('Edit', cl)
    db.security.addPermissionToRole('User', p)
# and give the regular users access to the web and email interface
p = db.security.getPermission('Web Access')
db.security.addPermissionToRole('User', p)
p = db.security.getPermission('Email Access')
db.security.addPermissionToRole('User', p)

# May users view other user information? Comment these lines out
# if you don't want them to
p = db.security.getPermission('View', 'user')
db.security.addPermissionToRole('User', p)

# Assign the appropriate permissions to the anonymous user's Anonymous
# Role. Choices here are:
# - Allow anonymous users to register through the web
p = db.security.getPermission('Web Registration')
db.security.addPermissionToRole('Anonymous', p)
# - Allow anonymous (new) users to register through the email gateway
p = db.security.getPermission('Email Registration')
db.security.addPermissionToRole('Anonymous', p)
# - Allow anonymous users access to the &quot;issue&quot; class of data
#   Note: this also grants access to related information like files,
#         messages, statuses etc that are linked to issues
#p = db.security.getPermission('View', 'issue')
#db.security.addPermissionToRole('Anonymous', p)
# - Allow anonymous users access to edit the &quot;issue&quot; class of data
#   Note: this also grants access to create related information like
#         files and messages etc that are linked to issues
#p = db.security.getPermission('Edit', 'issue')
#db.security.addPermissionToRole('Anonymous', p)

# oh, g'wan, let anonymous access the web interface too
p = db.security.getPermission('Web Access')
db.security.addPermissionToRole('Anonymous', p)
</pre>
<p>Note in the comments there the places where you might change the permissions
to restrict users or grant users more access. If you've created additional
classes that users should be able to edit and view, then you should add them
to the &quot;new permissions for this schema&quot; section at the start of the security
block. Then add them to the &quot;Assign the access and edit permissions&quot; section
too, so people actually have the new Permission you've created.</p>
<p>One final change is needed that finishes off the security system's
initialisation. We need to add a call to <tt class="docutils literal"><span class="pre">db.post_init()</span></tt> at the end of the
dbinit open() function. Add it like this:</p>
<pre class="literal-block">
import detectors
detectors.init(db)

# schema is set up - run any post-initialisation
db.post_init()
return db
</pre>
<p>You may verify the setup of Permissions and Roles using the new
&quot;<tt class="docutils literal"><span class="pre">roundup-admin</span> <span class="pre">security</span></tt>&quot; command.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id59" id="user-changes" name="user-changes">0.5.0 User changes</a></h3>
<p>To support all those schema changes, you'll need to massage your user database
a little too, to:</p>
<ol class="arabic simple">
<li>make sure there's an &quot;anonymous&quot; user - this user is mandatory now and is
the one that unknown users are logged in as.</li>
<li>make sure all users have at least one Role.</li>
</ol>
<p>If you don't have the &quot;anonymous&quot; user, create it now with the command:</p>
<pre class="literal-block">
roundup-admin create user username=anonymous roles=Anonymous
</pre>
<p>making sure the capitalisation is the same as above. Once you've done that,
you'll need to set the roles property on all users to a reasonable default.
The admin user should get &quot;Admin&quot;, the anonymous user &quot;Anonymous&quot;
and all other users &quot;User&quot;. The <tt class="docutils literal"><span class="pre">fixroles.py</span></tt> script in the tools directory
will do this. Run it like so (where python is your python 2+ binary):</p>
<pre class="literal-block">
python tools/fixroles.py -i &lt;tracker home&gt; fixroles
</pre>
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id60" id="cgi-interface-changes" name="cgi-interface-changes">0.5.0 CGI interface changes</a></h2>
<p>The CGI interface code was completely reorganised and largely rewritten. The
end result is that this section of your tracker interfaces module will need
changing from:</p>
<pre class="literal-block">
from roundup import cgi_client, mailgw
from roundup.i18n import _

class Client(cgi_client.Client):
    ''' derives basic CGI implementation from the standard module,
        with any specific extensions
    '''
    pass
</pre>
<p>to:</p>
<pre class="literal-block">
from roundup import mailgw
from roundup.cgi import client

class Client(client.Client):
    ''' derives basic CGI implementation from the standard module,
        with any specific extensions
    '''
    pass
</pre>
<p>You will also need to install the new version of roundup.cgi from the source
cgi-bin directory if you're using it.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id61" id="html-templating" name="html-templating">0.5.0 HTML templating</a></h2>
<p>You'll want to make a backup of your current tracker html directory. You
should then copy the html directory from the Roundup source &quot;classic&quot; template
and modify it according to your local schema changes.</p>
<p>If you need help with the new templating system, please ask questions on the
roundup-users mailing list (available through the roundup project page on
sourceforge, <a class="reference" href="http://roundup.sf.net/">http://roundup.sf.net/</a>)</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id62" id="detectors" name="detectors">0.5.0 Detectors</a></h2>
<p>The nosy reactor has been updated to handle the tracker not having an
&quot;assignedto&quot; property on issues. You may want to copy it into your tracker's
detectors directory. Chances are you've already fixed it though :)</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id63" id="migrating-from-0-4-1-to-0-4-2" name="migrating-from-0-4-1-to-0-4-2">Migrating from 0.4.1 to 0.4.2</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id64" id="id8" name="id8">0.4.2 Configuration</a></h2>
<p>The USER_INDEX definition introduced in 0.4.1 was too restrictive in its
allowing replacement of 'assignedto' with the user's userid. Users must change
the None value of 'assignedto' to 'CURRENT USER' (the string, in quotes) for
the replacement behaviour to occur now.</p>
<p>The new configuration variables are:</p>
<ul class="simple">
<li>EMAIL_KEEP_QUOTED_TEXT</li>
<li>EMAIL_LEAVE_BODY_UNCHANGED</li>
<li>ADD_RECIPIENTS_TO_NOSY</li>
</ul>
<p>See the sample configuration files in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/classic/instance_config.py
</pre>
<p>and:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/extended/instance_config.py
</pre>
<p>and the <a class="reference" href="customizing.html">customisation documentation</a> for information on how they're used.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id65" id="changes-to-detectors" name="changes-to-detectors">0.4.2 Changes to detectors</a></h2>
<p>You will need to copy the detectors from the distribution into your instance
home &quot;detectors&quot; directory. If you used the classic schema, the detectors
are in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/classic/detectors/
</pre>
<p>If you used the extended schema, the detectors are in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/extended/detectors/
</pre>
<p>The change means that schema-specific code has been removed from the
mail gateway and cgi interface and made into auditors:</p>
<ul class="simple">
<li>nosyreactor.py has now got an updatenosy auditor which updates the nosy
list with author, recipient and assignedto information.</li>
<li>statusauditor.py makes the unread or resolved -&gt; chatting changes and
presets the status of an issue to unread.</li>
</ul>
<p>There's also a bug or two fixed in the nosyreactor code.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id66" id="html-templating-changes" name="html-templating-changes">0.4.2 HTML templating changes</a></h2>
<p>The link() htmltemplate function now has a &quot;showid&quot; option for links and
multilinks. When true, it only displays the linked item id as the anchor
text. The link value is displayed as a tooltip using the title anchor
attribute. To use in eg. the superseder field, have something like this:</p>
<pre class="literal-block">
&lt;td&gt;
 &lt;display call=&quot;field('superseder', showid=1)&quot;&gt;
 &lt;display call=&quot;classhelp('issue', 'id,title', label='list', width=500)&quot;&gt;
 &lt;property name=&quot;superseder&quot;&gt;
  &lt;br&gt;View: &lt;display call=&quot;link('superseder', showid=1)&quot;&gt;
 &lt;/property&gt;
&lt;/td&gt;
</pre>
<p>The stylesheets have been cleaned up too. You may want to use the newer
versions in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/&lt;template&gt;/html/default.css
</pre>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id67" id="migrating-from-0-4-0-to-0-4-1" name="migrating-from-0-4-0-to-0-4-1">Migrating from 0.4.0 to 0.4.1</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id68" id="files-storage" name="files-storage">0.4.1 Files storage</a></h2>
<p>Messages and files from newly created issues will be put into subdierectories
in thousands e.g. msg123 will be put into files/msg/0/msg123, file2003
will go into files/file/2/file2003. Previous messages are still found, but
could be put into this structure.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id69" id="id9" name="id9">0.4.1 Configuration</a></h2>
<p>To allow more fine-grained access control, the variable used to check
permission to auto-register users in the mail gateway is now called
ANONYMOUS_REGISTER_MAIL rather than overloading ANONYMOUS_REGISTER. If the
variable doesn't exist, then ANONYMOUS_REGISTER is tested as before.</p>
<p>Configuring the links in the web header is now easier too. The following
variables have been added to the classic instance_config.py:</p>
<pre class="literal-block">
HEADER_INDEX_LINKS   - defines the &quot;index&quot; links to be made available
HEADER_ADD_LINKS     - defines the &quot;add&quot; links
DEFAULT_INDEX        - specifies the index view for DEFAULT
UNASSIGNED_INDEX     - specifies the index view for UNASSIGNED
USER_INDEX           - specifies the index view for USER
</pre>
<p>See the &lt;roundup source&gt;/roundup/templates/classic/instance_config.py for more
information - including how the variables are to be set up. Most users will
just be able to copy the variables from the source to their instance home. If
you've modified the header by changing the source of the interfaces.py file in
the instance home, you'll need to remove that customisation and move it into
the appropriate variables in instance_config.py.</p>
<p>The extended schema has similar variables added too - see the source for more
info.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id70" id="alternate-e-mail-addresses" name="alternate-e-mail-addresses">0.4.1 Alternate E-Mail Addresses</a></h2>
<p>If you add the property &quot;alternate_addresses&quot; to your user class, your users
will be able to register alternate email addresses that they may use to
communicate with roundup as. All email from roundup will continue to be sent
to their primary address.</p>
<p>If you have not edited the dbinit.py file in your instance home directory,
you may simply copy the new dbinit.py file from the core code. If you used
the classic schema, the interfaces file is in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/classic/dbinit.py
</pre>
<p>If you used the extended schema, the file is in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/extended/dbinit.py
</pre>
<p>If you have modified your dbinit.py file, you need to edit the dbinit.py
file in your instance home directory. Find the lines which define the user
class:</p>
<pre class="literal-block">
user = Class(db, &quot;msg&quot;,
                username=String(),   password=Password(),
                address=String(),    realname=String(),
                phone=String(),      organisation=String(),
                alternate_addresses=String())
</pre>
<p>You will also want to add the property to the user's details page. The
template for this is the &quot;user.item&quot; file in your instance home &quot;html&quot;
directory. Similar to above, you may copy the file from the roundup source if
you haven't modified it. Otherwise, add the following to the template:</p>
<pre class="literal-block">
&lt;display call=&quot;multiline('alternate_addresses')&quot;&gt;
</pre>
<p>with appropriate labelling etc. See the standard template for an idea.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id71" id="migrating-from-0-3-x-to-0-4-0" name="migrating-from-0-3-x-to-0-4-0">Migrating from 0.3.x to 0.4.0</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id72" id="message-id-and-in-reply-to-addition" name="message-id-and-in-reply-to-addition">0.4.0 Message-ID and In-Reply-To addition</a></h2>
<p>0.4.0 adds the tracking of messages by message-id and allows threading
using in-reply-to. Most e-mail clients support threading using this
feature, and we hope to add support for it to the web gateway. If you
have not edited the dbinit.py file in your instance home directory, you may
simply copy the new dbinit.py file from the core code. If you used the
classic schema, the interfaces file is in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/classic/dbinit.py
</pre>
<p>If you used the extended schema, the file is in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/extended/dbinit.py
</pre>
<p>If you have modified your dbinit.py file, you need to edit the dbinit.py
file in your instance home directory. Find the lines which define the msg
class:</p>
<pre class="literal-block">
msg = FileClass(db, &quot;msg&quot;,
                author=Link(&quot;user&quot;), recipients=Multilink(&quot;user&quot;),
                date=Date(),         summary=String(),
                files=Multilink(&quot;file&quot;))
</pre>
<p>and add the messageid and inreplyto properties like so:</p>
<pre class="literal-block">
msg = FileClass(db, &quot;msg&quot;,
                author=Link(&quot;user&quot;), recipients=Multilink(&quot;user&quot;),
                date=Date(),         summary=String(),
                files=Multilink(&quot;file&quot;),
                messageid=String(),  inreplyto=String())
</pre>
<p>Also, configuration is being cleaned up. This means that your dbinit.py will
also need to be changed in the open function. If you haven't changed your
dbinit.py, the above copy will be enough. If you have, you'll need to change
the line (round line 50):</p>
<pre class="literal-block">
db = Database(instance_config.DATABASE, name)
</pre>
<p>to:</p>
<pre class="literal-block">
db = Database(instance_config, name)
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id73" id="id10" name="id10">0.4.0 Configuration</a></h2>
<p><tt class="docutils literal"><span class="pre">TRACKER_NAME</span></tt> and <tt class="docutils literal"><span class="pre">EMAIL_SIGNATURE_POSITION</span></tt> have been added to the
instance_config.py. The simplest solution is to copy the default values
from template in the core source.</p>
<p>The mail gateway now checks <tt class="docutils literal"><span class="pre">ANONYMOUS_REGISTER</span></tt> to see if unknown users
are to be automatically registered with the tracker. If it is set to &quot;deny&quot;
then unknown users will not have access. If it is set to &quot;allow&quot; they will be
automatically registered with the tracker.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id74" id="cgi-script-roundup-cgi" name="cgi-script-roundup-cgi">0.4.0 CGI script roundup.cgi</a></h2>
<p>The CGI script has been updated with some features and a bugfix, so you should
copy it from the roundup cgi-bin source directory again. Make sure you update
the ROUNDUP_INSTANCE_HOMES after the copy.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id75" id="nosy-reactor" name="nosy-reactor">0.4.0 Nosy reactor</a></h2>
<p>The nosy reactor has also changed - copy the nosyreactor.py file from the core
source:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/&lt;template&gt;/detectors/nosyreactor.py
</pre>
<p>to your instance home &quot;detectors&quot; directory.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id76" id="id11" name="id11">0.4.0 HTML templating</a></h2>
<p>The field() function was incorrectly implemented - links and multilinks now
display as text fields when rendered using field(). To display a menu (drop-
down or select box) you need to use the menu() function.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id77" id="migrating-from-0-2-x-to-0-3-x" name="migrating-from-0-2-x-to-0-3-x">Migrating from 0.2.x to 0.3.x</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id78" id="x-cookie-authentication-changes" name="x-cookie-authentication-changes">0.3.x Cookie Authentication changes</a></h2>
<p>0.3.0 introduces cookie authentication - you will need to copy the
interfaces.py file from the roundup source to your instance home to enable
authentication. If you used the classic schema, the interfaces file is in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/classic/interfaces.py
</pre>
<p>If you used the extended schema, the file is in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/extended/interfaces.py
</pre>
<p>If you have modified your interfaces.Client class, you will need to take
note of the login/logout functionality provided in roundup.cgi_client.Client
(classic schema) or roundup.cgi_client.ExtendedClient (extended schema) and
modify your instance code apropriately.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id79" id="x-password-encoding" name="x-password-encoding">0.3.x Password encoding</a></h2>
<p>This release also introduces encoding of passwords in the database. If you
have not edited the dbinit.py file in your instance home directory, you may
simply copy the new dbinit.py file from the core code. If you used the
classic schema, the interfaces file is in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/classic/dbinit.py
</pre>
<p>If you used the extended schema, the file is in:</p>
<pre class="literal-block">
&lt;roundup source&gt;/roundup/templates/extended/dbinit.py
</pre>
<p>If you have modified your dbinit.py file, you may use encoded passwords:</p>
<ol class="arabic">
<li><p class="first">Edit the dbinit.py file in your instance home directory
a. At the first code line of the open() function:</p>
<pre class="literal-block">
 from roundup.hyperdb import String, Date, Link, Multilink

alter to include Password, as so::

 from roundup.hyperdb import String, Password, Date, Link, Multilink
</pre>
<ol class="loweralpha" start="2">
<li><p class="first">Where the password property is defined (around line 66):</p>
<pre class="literal-block">
user = Class(db, &quot;user&quot;,
                username=String(),   password=String(),
                address=String(),    realname=String(),
                phone=String(),      organisation=String())
user.setkey(&quot;username&quot;)
</pre>
<p>alter the &quot;password=String()&quot; to &quot;password=Password()&quot;:</p>
<pre class="literal-block">
user = Class(db, &quot;user&quot;,
                username=String(),   password=Password(),
                address=String(),    realname=String(),
                phone=String(),      organisation=String())
user.setkey(&quot;username&quot;)
</pre>
</li>
</ol>
</li>
<li><p class="first">Any existing passwords in the database will remain cleartext until they
are edited. It is recommended that at a minimum the admin password be
changed immediately:</p>
<pre class="literal-block">
roundup-admin -i &lt;instance home&gt; set user1 password=&lt;new password&gt;
</pre>
</li>
</ol>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id80" id="x-configuration" name="x-configuration">0.3.x Configuration</a></h2>
<p>FILTER_POSITION, ANONYMOUS_ACCESS, ANONYMOUS_REGISTER have been added to
the instance_config.py. Simplest solution is to copy the default values from
template in the core source.</p>
<p>MESSAGES_TO_AUTHOR has been added to the IssueClass in dbinit.py. Set to 'yes'
to send nosy messages to the author. Default behaviour is to not send nosy
messages to the author. You will need to add MESSAGES_TO_AUTHOR to your
dbinit.py in your instance home.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id81" id="x-cgi-script-roundup-cgi" name="x-cgi-script-roundup-cgi">0.3.x CGI script roundup.cgi</a></h2>
<p>There have been some structural changes to the roundup.cgi script - you will
need to install it again from the cgi-bin directory of the source
distribution. Make sure you update the ROUNDUP_INSTANCE_HOMES after the
copy.</p>
</div>
</div>
</div>
<div class="footer">
<hr class="footer" />
Generated on: 2006-10-04.

</div>
</body>
</html>