Table of Contents
Introduction
This is Cohere Reporting System 3.4! Cohere Reporting System 3.4 brings a lot
of great enhancements for Cohere Reporting System over previous versions,
with various improvements to the user interface, lots of interesting new
features, and many long-standing requests finally being addressed.
If you're upgrading, make sure to read Notes
On Upgrading From a Previous Version. If you are upgrading from a release
before 3.2, make sure to read the release notes for all the
previous versions in between your version
and this one, particularly the Upgrading section of each
version's release notes.
We would like to thank Canonical
Ltd. for funding development of one new feature, and NASA for funding
development of several new features through the
San Jose State University
Foundation.
Updates In This 3.4.x Release
3.4.14
This release fixes a security issue. See the
Security Advisory
for details.
3.4.13
This release fixes two security issues. See the
Security Advisory
for details.
3.4.12
This release fixes several security issues. See the
Security Advisory
for details.
3.4.11
Some users may have experienced difficulty updating to 3.4.10 due
to an error about "Math::Random::Secure::irand". Updating to 3.4.11
should work--Math::Random::Secure is no longer used by
the 3.4.x releases of Cohere Reporting System. (However, this series
is still secure--this is not a regression in Cohere Reporting System's
security.) See
Issue
646578 for details.
3.4.10
This release fixes several security issues, some of which are
highly critical. See the
Security Advisory
for details.
3.4.9
This release fixes some important security issues. See the
Security Advisory
for details.
3.4.8
This release fixes various security issues. See the
Security Advisory
for details.
Also, a regression in 3.4.7 that caused config.cgi to break has
been fixed in this release.
(Issue 577851)
3.4.7
This release fixes one security issue related to time tracking.
See the Security
Advisory for details.
In addition, the following important fixes/changes have been made in
this release:
- show_bug.cgi (the issue viewing/editing page)
should be considerably faster when you have many comments on
an Issue, now.
(Issue 498309)
- jobqueue.pl would lose its connection to the database and
stop sending emails if it was running for a long time.
(Issue 538705)
- When loading config.cgi, you can now specify
?flags=0 in the URL to specify that you don't want
flag data. This speeds up config.cgi considerably.
(Issue 553267)
- Logging in after changing your password would throw a confusing error.
(Issue 549814)
- Some crashes that would occur when using PostgreSQL and trying to
delete a custom field are now fixed.
(Issue 557495
and Issue 557686)
3.4.6
- When doing a search that involves "not equals" or "does not contain the
string" or similar "negative" search types, the search description that
appears at the top of the resulting issue list will indicate
that the search was of that type.
(Issue 474738)
- In Internet Explorer, users couldn't easily mark a RESOLVED DUPLICATE
issue as REOPENED, due to a JavaScript error.
(Issue 546719)
- If you use a "bookmarkable template" to pre-fill forms on
the issue-filing page, and you have custom fields
that are only supposed to appear (or only supposed to have certain
values) based on the values of other fields, those custom fields will
now work properly.
(Issue 538211)
- If you have a custom field that's only supposed to appear when
a issue's resolution is FIXED, it will now behave properly
on the issue-editing form when a user sets the issue's
status to RESOLVED.
(Issue 520993)
- If you are logged-out and using request.cgi, the Requester
and Requestee fields no longer respect the usermatching
parameter--they always require full usernames.
(Issue 533018)
- If you tried to do a search with too many terms (resulting in a URL
that was longer than about 7000 characters), Apache would return a
500 error instead of your search results.
(Issue 513989)
- Cohere Reporting System would sometimes lose fields from your sort order
when you added new fields to your sort order.
(Issue 470214)
- The Atom format of search results would sometimes be missing the
Reporter or Assignee field for some issues.
(Issue 537834)
3.4.5
This release contains fixes for multiple security issues. See the
Security Advisory
for details.
In addition, the following important fixes/changes have been made in
this release:
- Whining was failing if jobqueue.pl was enabled.
(Issue 530270)
- The Assignee field was empty in Whine mails.
(Issue 511216)
- Administrators can now successfully create user accounts using
editusers.cgi when using the "Env" authentication method.
(Issue 483987)
- Issuemail now uses the timezone of the recipient of the email,
when displaying the time a comment was made, instead of the timezone of the
person who made the change.
(Issue 534587)
- "issue 1234" in comments sometimes would not become a link if
word-wrapping happened between "issue" and the number.
(Issue 514703)
- Running checksetup.pl on Windows will no longer pop up an error box
about OCI.dll.
(Issue 480968)
3.4.4
This release contains a fix for a security issue. See the
Security Advisory
for details.
Additionally, this release fixes a few minor issues.
3.4.3
- Cohere Reporting System installations running under mod_perl were leaking
about 512K of RAM per page load.
(Issue 517793)
- Attachments with Unicode characters in their names were being downloaded
with mangled names.
(Issue 328628)
- Creating custom fields with Unicode in their database column name
is now no longer allowed, as it would break Cohere Reporting System. If you
created such a custom field, you should delete it by first marking it
obsolete and then clicking "Delete" in the custom field list, using
editfields.cgi.
(Issue 525025)
- Clicking "submit only my comment" on the "mid-air collisions" page
was leading to a "Suspicious Action" warning.
(Issue 514378)
- The XML format of an Issue accidentally contained the
word-wrapped content of comments instead of the unwrapped content.
(Issue 509152)
- You can now do ./install-module.pl --shell to get a CPAN
shell using the configuration of
install-module.pl,
which allows you to do more advanced Perl module installation tasks.
(Issue 445875)
3.4.2
This release contains fixes for multiple security issues, one of which
is highly critical. See the
Security Advisory
for details.
In addition, the following important fixes/changes have been made in
this release:
- Upgrades from older releases were sometimes failing during UTF-8
conversion with a foreign key error.
(Issue 508181)
- Sorting issue lists on certain fields would result in an error.
(Issue 510944)
- Issue update emails had two or three blank lines at the top
and between the various sections of the email. There is now only one
blank line in each of those places, making these emails more compact.
(Issue 73330)
- Issue email notifications for new issues incorrectly
had a line saying that the description was "Comment 0".
(Issue 510798)
- Running ./collectstats.pl --regenerate is now much faster,
on the order of 20x or 100x faster.
(Issue 286625)
- For users of RHEL, CentOS, Fedora, etc. jobqueue.pl can now automatically
be installed as a daemon by running ./jobqueue.pl install
as root.
(Issue 475403)
- XML-RPC interface responses had an incorrect Content-Length header
and would sometimes be truncated, if they contained certain UTF-8
characters.
(Issue 486306)
- Users who didn't have access to the time-tracking fields would get an
empty issue update email when the time-tracking fields were
changed.
(Issue 509035)
- In the New Charts, non-public series now no longer show up as selectable
if you cannot access them.
(Issue 389396)
3.4.1
This release contains an important security fix. See the
Security Advisory
for details.
Any requirements that are new since 3.2.3 will look like
this.
Perl
Perl v5.8.1
For MySQL
Users
- MySQL
v4.1.2
- perl module:
DBD::mysql v4.00
For PostgreSQL
Users
- PostgreSQL
v8.00.0000
- perl module:
DBD::Pg v1.45
For Oracle
Users
- Oracle
v10.02.0
- perl module:
DBD::Oracle v1.19
Required Perl Modules
| Module | Version |
| CGI |
3.33
|
| Digest::SHA |
(Any)
|
| Date::Format |
2.21
|
| DateTime |
0.28
|
| DateTime::TimeZone |
0.71
|
| DBI |
1.41
|
| Template |
2.22
|
| Email::Send |
2.00
|
| Email::MIME |
1.861
|
| Email::MIME::Encodings |
1.313
|
| Email::MIME::Modifier |
1.442
|
| URI |
(Any)
|
Optional Perl Modules
The following perl modules, if installed, enable various
features of Cohere Reporting System:
| Module | Version |
Enables Feature |
| LWP::UserAgent |
(Any)
|
Automatic Update Notifications |
| Template::Plugin::GD::Image |
(Any)
|
Graphical Reports |
| GD::Text |
(Any)
|
Graphical Reports |
| GD::Graph |
(Any)
|
Graphical Reports |
| GD |
1.20
|
Graphical Reports, New Charts, Old Charts |
| Email::MIME::Attachment::Stripper |
(Any)
|
Inbound Email |
| Email::Reply |
(Any)
|
Inbound Email |
| Net::LDAP |
(Any)
|
LDAP Authentication |
| TheSchwartz |
(Any)
|
Mail Queueing |
| Daemon::Generic |
(Any)
|
Mail Queueing |
| HTML::Parser |
3.40
|
More HTML in Product/Group Descriptions |
| HTML::Scrubber |
(Any)
|
More HTML in Product/Group Descriptions |
| XML::Twig |
(Any)
|
Move Bugs Between Installations |
| MIME::Parser |
5.406
|
Move Bugs Between Installations |
| Chart::Base |
1.0
|
New Charts, Old Charts |
| Image::Magick |
(Any)
|
Optionally Convert BMP Attachments to PNGs |
| PatchReader |
0.9.4
|
Patch Viewer |
| Authen::Radius |
(Any)
|
RADIUS Authentication |
| CGI |
3.51
|
Recommended important security fix |
| Authen::SASL |
(Any)
|
SMTP Authentication |
| SOAP::Lite |
0.710.06
|
XML-RPC Interface |
| mod_perl2 |
1.999022
|
mod_perl |
New Features and Improvements
When entering a new issue, the vast majority of fields are
now hidden by default, which enormously simplifies the bug-filing form.
You can click "Show Advanced Fields" to show all the fields, if you want
them. Cohere Reporting System remembers whether you last used the "Advanced"
or "Simple" version of the issue-entry form, and will display the
same version to you again next time you file an Issue.
Cohere Reporting System's front page has been redesigned to be better at
guiding new users into the activities that they most commonly want to
do. Further enhancements to the home page are coming in future versions
of Cohere Reporting System.
Email Addresses Hidden From Logged-Out
Users
To help prevent spam to Cohere Reporting System users, all email addresses
stored in Cohere Reporting System are now displayed only if you are logged in.
If you are logged out, only the part before the "@" of the email address is
displayed. This includes issue lists, viewing issues, the
XML format of an Issue, and any other place in the web interface that
an email address could appear.
Email addresses are not filtered out of issue comments.
The WebService still returns full email addresses, even if you are logged
out.
Shorter Search URLs
When submitting a search, all the unused fields are now stripped from
the URL, so search URLs are much more meaningful, and much shorter.
The largest performance problem in former versions of Cohere Reporting System
was that when updating issues, email would be sent immediately
to every user who needed to be notified, and process_bug.cgi
would wait for the emails to be sent before continuing.
Now Cohere Reporting System is capable of queueing emails to be sent
while an Issue is being updated, and sending them in the
background. This requires the administrator to run a daemon
that comes with Cohere Reporting System, named
jobqueue.pl,
and to enable the
use_mailer_queue parameter.
Using the background email-sending daemon instead of sending mail directly
should result in a very large speed-up for updating issues,
particularly on larger installations.
Users can now select what time zone they are in and Cohere Reporting System
will adjust displayed times to be correct for their time zone. However,
times the user inputs are unfortunately still in Cohere Reporting System's
time zone.
When creating a new custom field (or updating the definition of
an existing custom field), you can now say that "this field only
appears when field X has value Y". (In the future, you will be able
to select multiple values for "Y", so a field will appear when any
one of those values is selected.)
This feature only hides fields--it doesn't make their values go away.
So issues will still show up in searches for that field's
value, but the field won't appear in the user interface.
This is a good way of making Product-specific fields.
When creating a drop-down or multiple-selection custom field, you can
now specify that another field "controls the values" of this field.
Then, when adding values to this field, you can say that a particular
value only appears when the other field is set to a particular
value.
Here's an example: Let's say that we create a field called "Colors",
and we make the Product field "control the values" for Colors. Then we
add Blue, Red, Black, and Yellow as legal values for the "Colors" field.
Now we can say that "Blue" and "Red" only appear as valid choices in
Product A, "Yellow" only appears in Product B, but "Black" always
appears.
One thing to note is that this feature only controls what values appear in
the user interface. Cohere Reporting System itself will still accept
any combination of values as valid, in the backend.
You can now create a custom field that holds a reference to a single
valid issue ID. In the future this will be enhanced to allow
issues to refer to each other via this field.
We have added a new standard field called "See Also" to
Cohere Reporting System. In this field, you can put URLs to multiple
issues in any Cohere Reporting System installation, to indicate
that those issues are related to this one. It also supports
adding URLs to issues in
Launchpad.
Right now, the field just validates the URLs and then displays them, but
in the future, it will grab information from the other installation about
the issue and display it here, and possibly even update the
other installation.
If your installation does not need this field, you can hide it by disabling
the use_see_also
parameter.
There is a new interface for choosing what columns appear in search
results, which allows you to change the order in which columns appear
from left to right when viewing the issue list.
When displaying search results, Cohere Reporting System will now show
a brief description of what you searched for, at the top of the
issue list.
Other Enhancements and Changes
Enhancements for Users
- You can now log in from every page, using the login form that appears
in the header or footer when you click "Log In".
- When viewing an Issue, obsolete attachments are now
hidden from the attachment list by default. You can show them
by clicking "Show Obsolete" at the bottom of the attachment list.
- In the Email Preferences, you can now choose to get email when
a new issue report is filed and you have a particular
role on it.
- When resolving a mid-air collision, you can now choose to submit
only your comment.
- You can now set the Blocks and Depends On field on the "Change
Several Issues At Once" page.
- If your installation uses the "insidergroup" feature, you can now add
private comments on the "Change Several Issues At Once"
page.
- When viewing a search result, you can now hover over any abbreviated
field to see its full value.
- When logging out, users are now redirected to the main page of
Cohere Reporting System instead of an empty page.
- When editing an Issue, text fields (except the comment box) now
grow longer when you widen your browser window.
- When viewing an Issue, the Depends On and Blocks list will
display an Issue's alias if it has one, instead of its id.
Also, closed issues will be sorted to the end of the list.
- If you use the time-tracking features of Cohere Reporting System, and
you enable the time-tracking related columns in a search result,
then you will see a summary of the time-tracking data at the
bottom of the search result.
- For users of time-tracking, the summarize_time.cgi page
now contains more data.
- When viewing an attachment's details page while you are logged-out,
flags are no longer shown as editable.
- Cloning an Issue will now retain the "Blocks" and "Depends On"
fields from the issue being cloned.
- Issuemail for new issues will now indicate
what security groups the issue has been restricted to.
- You can now use any custom drop-down field as an axis for a tabular
or graphical report.
- The X-Bugzilla-Type header in emails sent by
Cohere Reporting System is now "new" for issuemail sent for
newly-filed issues, and "changed" for emails having to do
with updated issues.
- Mails sent by the "Whining" system now contain the header
X-Bugzilla-Type: whine.
- issuemail now contains a X-Bugzilla-URL header to uniquely
identify which Cohere Reporting System installation the email came from.
- If you input an invalid regular expression anywhere in
Cohere Reporting System, it will now tell you explicitly instead of failing
cryptically.
- The duplicates.xul page (which wasn't used by very many
people) is now gone.
Enhancements for Administrators and Developers
- Cohere Reporting System now uses the SHA-256 algorithm (a variant of
SHA-2) to encrypt passwords in the database, instead of using Unix's
"crypt" function. This allows passwords longer than eight characters
to actually be effective. Each user's password will be converted to
SHA-256 the first time they log in after you upgrade to
Cohere Reporting System 3.4 or later.
- If you are using database replication with Cohere Reporting System,
many more scripts now take advantage of the read-only slave (the
"shadowdb"). It may be safe to open up show_bug.cgi
to search-engine indexing by editing your robots.txt file,
now, if your Cohere Reporting System is on fast-enough hardware.
- The database now uses foreign keys to enforce the validity of
relationships between tables. Not every single table has all its
foreign keys yet, but most do.
- Various parameters have been removed, in an effort to de-clutter
the parameter interface and simplify Cohere Reporting System's code.
The parameters that were removed were: timezone, supportwatchers,
maxpatchsize, commentonclearresolution, commentonreassignbycomponent,
showallproducts. They have all been replaced with sensible default
behaviors. (For example, user watching is now always enabled.)
- When adding
&debug=1 to the end of a
buglist.cgi URL, Cohere Reporting System will now also do an
EXPLAIN on the query, to help debug performance issues.
- When editing flag types in the administrative interface, you can now
see how many flags of each type have been set.
WebService Changes
- Various functions have been added to the WebService:
Bug.history,
Bug.search,
Bug.comments,
Bug.update_see_also,
User.get,
and Bugzilla.time
(Bugzilla.timezone is now deprecated).
- For network efficiency, you can now limit which fields are returned
from certain WebService functions, like User.get.
- There is now a "permissive" argument for the Bug.get
WebService function, which causes it not to throw an error when you
ask for issues you can't see.
- The Bug.get method now returns many more fields.
- The Bug.add_comment method now returns the ID of the comment
that was just added.
- The Bug.add_comment method will now throw an error if you
try to add a private comment but do not have the correct permissions.
(In previous versions, it would just silently ignore the private
argument if you didn't have the correct permissions.)
- Many WebService function parameters now take individual values in
addition to arrays.
- The WebService now validates input types--it makes sure that dates
are in the right format, that ints are actually ints, etc. It will throw
an error if you send it invalid data. It also accepts empty ints, doubles,
and dateTimes, and translates them to undef.
- Issue 423439: Tabs in comments will be converted
to four spaces, due to a bug in Perl as of Perl 5.8.8.
- Issue 69621: If you rename or remove a keyword that is
in use on issues, you will need to rebuild the "keyword cache"
by running sanitycheck.cgi and choosing
the option to rebuild the cache when it asks. Otherwise keywords may
not show up properly in search results.
- Issue 89822: When changing multiple issues at
the same time, there is no "mid-air collision" protection.
- Issue 276230: The support for restricting access to
particular Categories of New Charts is not complete. You should treat
the 'chartgroup' Param as the only access mechanism available.
However, charts migrated from Old Charts will be restricted to
the groups that are marked MANDATORY for the corresponding Product.
There is currently no way to change this restriction, and the
groupings will not be updated if the group configuration
for the Product changes.
- Issue 370370: mod_perl support is currently not
working on Windows machines.
When upgrading to 3.4, checksetup.pl will create foreign keys
for many columns in the database. Before doing this, it will check the
database for consistency. If there are an unresolvable consistency
problems, it will tell you what table and column in the database contain
the bad values, and which values are bad. If you don't know what else to do,
you can always delete the database records which contain the bad values by
logging in to your database and running the following command:
DELETE FROM table WHERE column IN
(1, 2, 3, 4)
Just replace "table" and "column" with the name of the table
and column that checksetup.pl mentions, and "1, 2, 3, 4"
with the invalid values that checksetup.pl prints out.
Remember that you should always back up your database before doing
an upgrade.
Code Changes Which May Affect
Customizations
- checksetup.pl now re-writes the localconfig
file every time it runs, keeping the current values set (if there
are any), but moving any unexpected variables into a file called
localconfig.old. If you want to continue having custom
varibles in localconfig, you will have to add them to
the
LOCALCONFIG_VARS constant in
Bugzilla::Install::Localconfig.
- Bugzilla::Object->update() now returns something different
in list context than it does in scalar context.
- Bugzilla::Object->check() now can take object
ids in addition to names. Just pass in
{ id => $some_value
}.
- Instead of being defined in buglist.cgi, columns for
search results are now defined in a subroutine called
COLUMNS
in Bugzilla::Search. The data now mostly comes from the
fielddefs table in the database. Search.pm now takes a list
of column names from fielddefs for its fields argument instead
of literal SQL columns.
- Bugzilla::Field->legal_values now returns an array of
Bugzilla::Field::Choice
objects instead of an array of strings. Bugzilla::Field::Choice will be used
in more places, in the future.
- We now use Bugzilla::Bug->check() instead of
ValidateBugId.
- The groups and bless_groups methods in
Bugzilla::User now return an arrayref of
Bugzilla::Group objects instead of a hashref with
group ids and group names.
- Standard Cohere Reporting System drop-down fields now have their type
set to FIELD_TYPE_SINGLE_SELECT in the fielddefs table.
- Bugzilla->usage_mode now defaults to
USAGE_MODE_CMDLINE if we are not running inside a web
server.
- We no longer delete environment variables like $ENV{PATH}
automatically unless we're actually running in taint mode.
- We are now using YUI 2.6.0.
- In the RDF format of config.cgi,
the "resource" attribute for flags now contains "flag.cgi" instead
of "flags.cgi".
Cohere Reporting System 3.2 Release Notes
Table of Contents
Introduction
Welcome to Cohere Reporting System 3.2! This is our first major feature
release since Cohere Reporting System 3.0, and it brings a lot of great
improvements and polish to the Cohere Reporting System experience.
If you're upgrading, make sure to read How to
Upgrade From An Older Version. If you are upgrading from a release
before 3.0, make sure to read the release notes for all the
previous versions in between your version
and this one, particularly the "Notes For Upgraders" section of each
version's release notes.
This section describes what's changed in the most recent bug-fix
releases of Cohere Reporting System after 3.2. We only list the
most important fixes in each release. If you want a detailed list of
everything that's changed in each version, you should use our
Change Log
Page.
3.2.3
- Cohere Reporting System is now compatible with MySQL 5.1.x versions 5.1.31
and greater.
(Issue 480001)
- On Windows, Cohere Reporting System sometimes would send mangled emails
(that would often fail to send).
(Issue 467920)
recode.pl would sometimes crash when trying to convert
databases from older versions of Cohere Reporting System.
(Issue 431201)- Running a saved search with Unicode characters in its name would
cause Cohere Reporting System to crash.
(Issue 477513)
- Cohere Reporting System clients like Mylyn can now update issues
again (the issue XML format now contains a "token" element that
can be used when updating an Issue).
(Issue 476678)
- For installations using the
shadowdb parameter,
Cohere Reporting System was accidentally writing to the "tokens" table
in the shadow database (instead of the master database) when using the
"Change Several Issues at Once" page.
(Issue 476943)
This release also contains a security fix. See the
Security Fixes Section for details.
3.2.2
This release fixes one security issue that is critical for installations
running 3.2.1 under mod_perl. See the
Security Advisory
for details.
3.2.1
- Attachments, charts, and graphs would sometimes be garbled on Windows.
(Issue 464992)
- Saving changes to parameters would sometimes fail silently (particularly
on Windows when the web server didn't have the right permissions to
update the
params file). Cohere Reporting System will now
throw an error in this case, telling you what is wrong.
(Issue 347707)
- If you were using the
usemenuforusers parameter,
and an Issue was assigned to (or had a QA Contact of) a disabled
user, that field would be reset to the first user in the list when
updating an Issue.
(Issue 465589)
- If you were using the
PROJECT environment variable
to have multiple Cohere Reporting System installations using one codebase,
project-specific templates were being ignored.
(Issue 467324)
- Some versions of the SOAP::Lite Perl module had a bug that caused
Cohere Reporting System's XML-RPC service to break.
checksetup.pl now checks for these bad versions and
will reject them.
(Issue 468009)
- The font sizes in various places were too small, when using the
Classic skin.
(Issue 469136)
3.2.3
This release fixes one security issue related to attachments. See the
Security Advisory
for details.
3.2.2
This release fixes one security issue that is critical for installations
running 3.2.1 under mod_perl. See the
Security Advisory
for details.
3.2.1
This release contains several security fixes. One fix may break any
automated scripts you have that are loading process_bug.cgi
directly. We recommend that you read the entire
Security Advisory
for this release.
Minimum Requirements
Any requirements that are new since 3.0.5 will look like
this.
Perl
Perl v5.8.1
For MySQL Users
- MySQL v4.1.2
- perl module:
DBD::mysql v4.00
For PostgreSQL Users
- PostgreSQL v8.00.0000
- perl module: DBD::Pg v1.45
Email Addresses Hidden From Logged-Out
UsersFor Oracle Users
- Oracle v10.02.0
- perl module: DBD::Oracle v1.19
Required Perl Modules
| Module | Version |
| CGI | 3.21 (on Perl 5.8.x)
or 3.33 (on Perl 5.10.x) |
| Date::Format | 2.21 |
| File::Spec | 0.84 |
| DBI | 1.41 |
| Template | 2.15 |
| Email::Send | 2.00 |
| Email::MIME | 1.861 |
| Email::MIME::Encodings |
1.313 |
| Email::MIME::Modifier |
1.442 |
Optional Perl Modules
The following perl modules, if installed, enable various
features of Cohere Reporting System:
| Module |
Version |
Enables Feature |
| LWP::UserAgent |
(Any) |
Automatic Update Notifications |
| Template::Plugin::GD::Image |
(Any) |
Graphical Reports |
| GD::Text |
(Any) |
Graphical Reports |
| GD::Graph |
(Any) |
Graphical Reports |
| GD |
1.20 |
Graphical Reports, New Charts, Old Charts |
| Email::MIME::Attachment::Stripper |
(Any) |
Inbound Email |
| Email::Reply |
(Any) |
Inbound Email |
| Net::LDAP |
(Any) |
LDAP Authentication |
| HTML::Parser |
3.40 |
More HTML in Product/Group Descriptions |
| HTML::Scrubber |
(Any) |
More HTML in Product/Group Descriptions |
| XML::Twig |
(Any) |
Move Issues Between Installations |
| MIME::Parser |
5.406 |
Move Issues Between Installations |
| Chart::Base |
1.0 |
New Charts, Old Charts |
| Image::Magick |
(Any) |
Optionally Convert BMP Attachments to PNGs |
| PatchReader |
0.9.4 |
Patch Viewer |
| Authen::Radius |
(Any) |
RADIUS Authentication |
| Authen::SASL |
(Any) |
SMTP Authentication |
| SOAP::Lite |
(Any) |
XML-RPC Interface |
| mod_perl2 |
1.999022 |
mod_perl |
New Features and Improvements
Major UI Improvements
Cohere Reporting System 3.2 has had some UI assistance from the NASA
Human-Computer Interaction department and the new
Cohere Reporting System
User Interface Team.
In particular, you will notice a massively redesigned issue
editing form, in addition to our new skin.
New Default Skin: Dusk
Cohere Reporting System 3.2 now ships with a skin called "Dusk" that is
a bit more colorful than old default "Classic" skin.
Upgrading installations will still default to the "Classic"
skin--administrators can change the default in the Default Preferences
control panel. Users can also choose to use the old skin in their
Preferences (or using the View :: Page Style menu in Firefox).
The changes that Cohere Reporting System required for Dusk made
Cohere Reporting System much easier to skin. See the
Addons page
for additional skins, or try making your own!
Custom Status Workflow
You can now customize the list of statuses in Cohere Reporting System,
and transitions between them.
You can also specify that a comment must be made on certain transitions.
New Custom Field Types
Cohere Reporting System 3.2 has support for three new types of
custom fields:
- Large Text: Adds a multi-line textbox to your issues.
- Multiple Selection Box: Adds a box that allows you to choose
multiple items from a list.
- Date/Time: Displays a date and time, along with a JavaScript
calendar popup to make picking a date easier.
Easier Installation
Cohere Reporting System now comes with a script called
install-module.pl that can automatically download
and install all of the required Perl modules for Cohere Reporting System.
It stores them in a directory inside your Cohere Reporting System
installation, so you can use it even if you don't have administrator-level
access to your machine, and without modifying your main Perl install.
checksetup.pl will print out instructions for using
install-module.pl, or you can read its
documentation.
Experimental Oracle Support
Cohere Reporting System 3.2 contains experimental support for using
Oracle as its database. Some features of Cohere Reporting System are known
to be broken on Oracle, but hopefully will be working by our next major
release.
The Cohere Reporting System Project, as an open-source project, of course
does not recommend the use of proprietary database solutions. However,
if your organization requires that you use Oracle, this will allow
you to use Cohere Reporting System!
The Cohere Reporting System Project thanks Oracle Corp. for their extensive
development contributions to Cohere Reporting System which allowed this to
happen!
Improved UTF-8 Support
Cohere Reporting System 3.2 now has advanced UTF-8 support in its code,
including correct handling for truncating and wrapping multi-byte
languages. Major issues with multi-byte or unusual languages
are now resolved, and Cohere Reporting System should now be usable
by users in every country with little (or at least much less)
customization.
Group Icons
Administrators can now specify that users who are in certain groups
should have an icon appear next to their name whenever they comment.
This is particularly useful for distinguishing developers from
issue reporters.
Other Enhancements and Changes
These are either minor enhancements, or enhancements that have
very short descriptions. Some of these are very useful, though!
Enhancements For Users
- Issues: You can now reassign
an Issue at the same time as you are changing its status.
- Issues: When entering an Issue,
you will now see the description of a component when you select it.
- Issues: The issue view now
contains some Microformats,
most notably for users' names and email addresses.
- Issues: You can now remove a QA Contact
from an Issue simply by clearing the QA Contact field.
- Issues: There is now a user preference
that will allow you to exclude the quoted text when replying
to comments.
- Issues: You can now expand or collapse
individual comments in the issue view.
- Attachments: There is now "mid-air collision"
protection when editing attachments.
- Attachments: Patches in the Diff Viewer now show
line numbers (Example).
- Attachments: After creating or updating an attachment,
you will be immediately shown the issue that the attachment
is on.
- Search: You can now reverse the sort of
an Issue list by clicking on a column header again.
- Search: Atom feeds of issue lists now
contain more fields.
- Search: QuickSearch now supports searching flags
and groups. It also now includes the OS field in the list of fields
it searches by default.
- Search: "Help" text can now appear on query.cgi
for Internet Explorer and other non-Firefox browsers. (It always
could appear for Firefox.)
- Cohere Reporting System now ships with an icon that will show
up next to the URL in most browsers. If you want to replace it,
it's in images/favicon.ico.
- You can now set the Deadline when using "Change Several
Issues At Once"
- Saved Searches now save their column list, so if
you customize the list of columns and save your search, it will
always contain those columns.
- Saved Searches: When you share a search, you can
now see how many users have subscribed to it, on
userprefs.cgi.
- Saved Searches: You can now see what group a
shared search was shared to, on the list of available shared searches
in userprefs.cgi.
- Flags: If your installation uses drop-down user
lists, the flag requestee box will now contain only users who are
actually allowed to take requests.
- Flags: If somebody makes a request to you, and you
change the requestee to somebody else, the requester is no longer set
to you. In other words, you can "redirect" requests and maintain the
original requester.
- Flags: Emails about flags now will thread properly
in email clients to be a part of an Issue's thread.
- When using email_in.pl, you can now add users to the CC
list by just using @cc as the field name.
- Many pages (particularly administrative pages) now contain links to
the relevant section of the Cohere Reporting System Guide, so you can read
the documentation for that page.
- Dependency Graphs should render more quickly, as they now (by default)
only include the same issues that you'd see in the dependency
tree.
Enhancements For Administrators
- Admin UI: Instead of having the Administration
Control Panel links in the footer, there is now just one link called
"Administration" that takes you to a page that links to all the
administrative controls for Cohere Reporting System.
- Admin UI: Administrative pages no longer display
confirmation pages, instead they redirect you to some useful page
and display a message about what changed.
- Admin UI: The interface for editing group
inheritance in editgroups.cgi is much clearer now.
- Admin UI: When editing a user, you can now see
all the components where that user is the Default Assignee or Default
QA Contact.
- Email: For installations that use SMTP to send
mail (as opposed to Sendmail), Cohere Reporting System now supports
SMTP Authentication, so that it can log in to your mail server
before sending messages.
- Email: Using the "Test" mail delivery method now
creates a valid mbox file to make testing easier.
- Authentication: Cohere Reporting System now correctly
handles LDAP records which contain multiple email addresses. (The first
email address in the list that is a valid Cohere Reporting System account
will be used, or if this is a new user, the first email address in
the list will be used.)
- Authentication: Cohere Reporting System can now take
a list of LDAP servers to try in order until it gets a successful
connection.
- Authentication: Cohere Reporting System now supports
RADIUS authentication.
- Security: The login cookie is now created as
"HTTPOnly" so that it can't be read by possibly malicious scripts.
Also, if SSL is enabled on your installation, the login cookie is
now only sent over SSL connections.
- Security: The
ssl parameter now protects
every page a logged-in user accesses, when set to "authenticated sessions."
Also, SSL is now enforced appropriately in the WebServices interface when
the parameter is set.
- Database: Cohere Reporting System now uses transactions in
the database instead of table locks. This should generally improve
performance with many concurrent users. It also means if there is
an unexpected error in the middle of a page, all database changes made
during that page will be rolled back.
- Database: You no longer have to set
max_packet_size in MySQL to add large attachments. However,
you may need to set it manually if you restore a mysqldump into your
database.
- New WebService functions:
Bug.add_comment
and Bugzilla.extensions.
- You can now delete custom fields, but only if they have never been
set on any issue.
- There is now a --reset-password argument to
checksetup.pl that allows you to reset a user's password
from the command line.
- There is now a script called sanitycheck.pl that you can
run from the command line. It works just like sanitycheck.cgi.
By default, it only outputs anything if there's an error, so it's
ideal for administrators who want to run it nightly in a cron job.
- The strict_isolation parameter now prevents you from setting
users who cannot see an Issue as a CC, Assignee, or QA
Contact. Previously it only prevented you from adding users who
could not edit the issue.
- Extensions can now add their own headers to the HTML <head>
for things like custom CSS and so on.
- sanitycheck.cgi has been templatized, meaning that the
entire Cohere Reporting System UI is now contained in templates.
- When setting the sslbase parameter, you can now specify
a port number in the URL.
- When importing issues using importxml.pl,
attachments will have their actual creator set as their creator,
instead of the person who exported the issue from the other
system.
- The voting system is off by default in new installs. This is to
prepare for the fact that it will be moved into an extension at
some point in the future.
- The
shutdownhtml parameter now works even when
Cohere Reporting System's database server is down.
Enhancements for Localizers (or Localized Installations)
- The documentation can now be localized--in other words, you can have
documentation installed for multiple languages at once and
Cohere Reporting System will link to the correct language in its internal
documentation links.
- Cohere Reporting System no longer uses the languages parameter.
Instead it reads the template/ directory to see which
languages are available.
- Some of the messages printed by checksetup.pl can now
be localized. See template/en/default/setup/strings.txt.pl.
Outstanding Issues
- Issue 423439: Tabs in comments will be converted
to four spaces, due to a bug in Perl as of Perl 5.8.8.
- Issue 69621: If you rename or remove a keyword that is
in use on issues, you will need to rebuild the "keyword cache"
by running sanitycheck.cgi and choosing
the option to rebuild the cache when it asks. Otherwise keywords may
not show up properly in search results.
- Issue 89822: When changing multiple issues at
the same time, there is no "mid-air collision" protection.
- Issue 276230: The support for restricting access to
particular Categories of New Charts is not complete. You should treat
the 'chartgroup' Param as the only access mechanism available.
However, charts migrated from Old Charts will be restricted to
the groups that are marked MANDATORY for the corresponding Product.
There is currently no way to change this restriction, and the
groupings will not be updated if the group configuration
for the Product changes.
- Issue 370370: mod_perl support is currently not
working on Windows machines.
How to Upgrade From An Older Version
Notes For Upgraders
- If you upgrade by CVS, the extensions and
skins/contrib directories are now in CVS instead of
being created by checksetup.pl If you do a cvs update
from 3.0, you will be told that your directories are "in the way" and
you should delete (or move) them and then do cvs update
again. Also, the docs directory has been restructured
and after you cvs update you can delete the docs/html,
docs/pdf, docs/txt, and docs/xml
directories.
- If you are using MySQL, you should know that Cohere Reporting System
now uses InnoDB for all tables. checksetup.pl will convert
your tables automatically, but if you have InnoDB disabled,
the upgrade will not be able to complete (and checksetup.pl
will tell you so).
- You should also read the
Cohere Reporting System 3.0 Notes For Upgraders
section of the
previous release notes if you are upgrading
from a version before 3.0.
Steps For Upgrading
Once you have read the notes above, see the
Upgrading
documentation for instructions on how to upgrade.
Code Changes Which May Affect
Customizations
More Hooks!
There are more code hooks in 3.2 than there were in 3.0. See the
documentation of Bugzilla::Hook
for more details.
Search.pm Rearchitecture
Bugzilla/Search.pm has been heavily modified, to be much
easier to read and use. It contains mostly the same code as it did in
3.0, but it has been moved around and reorganized significantly.
lib Directory
As part of implementing install-module.pl,
Cohere Reporting System was given a local lib directory which
it searches for modules, in addition to the standard system path.
This means that all Cohere Reporting System scripts now start with
use lib qw(. lib); as one of the first lines.
Other Changes
- You should now be using
get_status('NEW') instead of
status_descs.NEW in templates.
- The
[%# version = 1.0 %] comment at the top of every
template file has been removed.
Cohere Reporting System 3.0.x Release Notes
Table of Contents
Introduction
Welcome to Cohere Reporting System 3.0! It's been over eight years since
we released Cohere Reporting System 2.0, and everything has changed since
then. Even just since our previous release, Cohere Reporting System 2.22,
we've added a lot of new features. So enjoy the release, we're
happy to bring it to you.
If you're upgrading, make sure to read How to
Upgrade From An Older Version. If you are upgrading from a release
before 2.22, make sure to read the release notes for all the
previous versions in between your version
and this one.
Updates in this 3.0.x Release
This section describes what's changed in the most recent bug-fix
releases of Cohere Reporting System after 3.0. We only list the
most important fixes in each release. If you want a detailed list of
everything that's changed in each version, you should use our
Change Log Page.
3.0.6
- Before 3.0.6, unexpected fatal WebService errors would result in
a
faultCode that was a string instead of a number.
(Issue 446327)
- If you created a product or component with the same name as one you
previously deleted, it would fail with an error about the series table.
(Issue 247936)
See also the Security Advisory section for
information about a security issue fixed in this release.
3.0.5
- If you don't have permission to set a flag, it will now appear
unchangeable in the UI.
(Issue 433851)
- If you were running mod_perl, Cohere Reporting System was not correctly
closing its connections to the database since 3.0.3, and so sometimes
the DB would run out of connections.
(Issue 441592)
- The installation script is now clear about exactly which
Email:: modules are required in Perl, thus avoiding the
problem where emails show up with a body like
SCALAR(0xBF126795).
(Issue 441541)
- email_in.pl
is no longer case-sensitive for values of @product.
(Issue 365697)
See also the Security Advisory section for
information about security issues fixed in this release.
3.0.4
- Cohere Reporting System administrators were not being correctly notified
about new releases.
(Issue 414726)
- There could be extra whitespace in email subject lines.
(Issue 411544)
- The priority, severity, OS, and platform fields were always required by
the Bug.create WebService function, even if they had
defaults specified.
(Issue 384009)
- Better threading of issuemail in some email clients.
(Issue 376453)
- There were many fixes to the Inbound Email Interface
(email_in.pl).
(Issue 92274,
Issue 377025,
Issue 412943,
Issue 413672, and
Issue 431721)
- checksetup.pl now handles UTF-8 conversion more reliably during upgrades.
(Issue 374951)
- Comments written in CJK languages are now correctly word-wrapped.
(Issue 388723)
- All emails will now be sent in the correct language, when the user
has chosen a language for emails.
(Issue 405946)
- On Windows, temporary files created when uploading attachments are now
correctly deleted when the upload is complete.
(Issue 414002)
- checksetup.pl now prints correct installation instructions
for Windows users using Perl 5.10.
(Issue 414430)
See also the Security Advisory section for
information about security issues fixed in this release.
3.0.3
- mod_perl no longer compiles Cohere Reporting System's code for each Apache
process individually. It now compiles code only once and shares it among
each Apache process. This greatly improves performance and highly
decreases the memory footprint.
(Issue 398241)
- You can now search for '---' (without quotes) in versions and milestones.
(Issue 362436)
- Cohere Reporting System should no longer break lines unnecessarily in
email subjects. This was causing trouble with some email clients.
(Issue 374424)
- If you had selected "I'm added to or removed from this capacity" option
for the "CC" role in your email preferences, you wouldn't get mail when
more than one person was added to the CC list at once.
(Issue 394796)
- Deleting a user account no longer deletes whines from another user who
has the deleted account as addressee. The schedule is simply removed,
but the whine itself is left intact.
(Issue 395924)
- contrib/merge-users.pl now correctly merges all required
fields when merging two user accounts.
(Issue 400160)
- Cohere Reporting System no longer requires Apache::DBI to run under
mod_perl. It caused troubles such as lost connections with the DB and
didn't give any important performance gain.
(Issue 408766)
3.0.2
- Cohere Reporting System should now work on Perl 5.9.5 (and thus the
upcoming Perl 5.10.0).
(Issue 390442)
See also the Security Advisory section for
information about an important security issue fixed in this release.
3.0.1
- For users of Firefox 2, the
show_bug.cgi user interface
should no longer "collapse" after you modify an Issue.
(Issue 370739)
- If you can bless a group, and you share a saved search with that
group, it will no longer automatically appear in all of that group's
footers unless you specifically request that it automatically appear
in their footers.
(Issue 365890)
- There is now a parameter to allow users to perform searches without
any search terms. (In other words, to search for just a Product
and Status on the Simple Search page.) The parameter is called
specific_search_allow_empty_words.
(Issue 385910)
- If you attach a file that has a MIME-type of
text/x-patch
or text/x-diff, it will automatically be treated as a
patch by Cohere Reporting System.
(Issue 365756)
- Dependency Graphs now work correctly on all mod_perl installations.
There should now be no remaining signficant problems with running
Cohere Reporting System under mod_perl.
(Issue 370398)
- If moving an Issue between products would remove groups
from the issue, you are now warned.
(Issue 303183)
- On IIS, whenever Cohere Reporting System threw a warning, it would
actually appear on the web page. Now warnings are suppressed,
unless you have a file in the
data directory called
errorlog, in which case warnings will be printed there.
(Issue 390148)
- If you used email_in.pl to edit an Issue that was
protected by groups, all of the groups would be cleared.
(Issue 385453)
- PostgreSQL users: New Charts were failing to collect data over time.
They will now start collecting data correctly.
(Issue 257351)
- Some flag mails didn't specify who the requestee was.
(Issue 379787)
- Instead of throwing real errors, collectstats.pl would
just say that it couldn't find
ThrowUserError.
(Issue 380709)
- Logging into Cohere Reporting System from the home page works again
with IIS5.
(Issue 364008)
- If you were using SMTP for sending email, sometimes emails would
be missing the
Date header.
(Issue 304999).
- In the XML-RPC WebService,
Bug.legal_values now
correctly returns values for custom fields if you request values
for custom fields.
(Issue 381737)
- The "Issue-Writing Guidelines" page has been shortened
and re-written.
(Issue 378590)
- If your
urlbase parameter included a port number,
like www.domain.com:8080, SMTP might have failed.
(Issue 384501)
- For SMTP users, there is a new parameter,
smtp_debug.
Turning on this parameter will log the full information about
every SMTP session to your web server's error log, to help with
debugging issues with SMTP.
(Issue 384497)
- If you are a "global watcher" (you get all mails from every
issue), you can now see that in your Email Preferences.
(Issue 365302)
- The Status and Resolution of issues are now correctly
localized in CSV search results.
(Issue 389517)
- The "Subject" line of an email was being mangled if it contained
non-Latin characters.
(Issue 387860)
- Editing the "languages" parameter using editparams.cgi would
sometimes fail, causing Cohere Reporting System to throw an error.
(Issue 335354)
Minimum Requirements
Any requirements that are new since 2.22 will look like
this.
Perl
- Perl v5.8.0 (non-Windows
platforms)
- Perl v5.8.1 (Windows platforms)
For MySQL Users
- MySQL v4.1.2
- perl module: DBD::mysql v2.9003
For PostgreSQL Users
- PostgreSQL v8.00.0000
- perl module: DBD::Pg v1.45
Required Perl Modules
| Module | Version |
| CGI | 2.93 |
| Date::Format | 2.21 |
| DBI |
1.41 |
| File::Spec | 0.84 |
| Template | 2.12 |
| Email::Send |
2.00 |
| Email::MIME |
1.861 |
| Email::MIME::Modifier |
1.442 |
Optional Perl Modules
The following perl modules, if installed, enable various
features of Cohere Reporting System:
| Module | Version |
Enables Feature |
| LWP::UserAgent |
(Any) |
Automatic Update Notifications |
| Template::Plugin::GD::Image |
(Any) |
Graphical Reports |
| GD::Graph |
(Any) |
Graphical Reports |
| GD::Text |
(Any) |
Graphical Reports |
| GD |
1.20 |
Graphical Reports, New Charts, Old Charts |
| Email::MIME::Attachment::Stripper |
(Any) |
Inbound Email |
| Email::Reply |
(Any) |
Inbound Email |
| Net::LDAP |
(Any) |
LDAP Authentication |
| HTML::Parser |
3.40 |
More HTML in Product/Group Descriptions |
| HTML::Scrubber |
(Any) |
More HTML in Product/Group Descriptions |
| XML::Twig |
(Any) |
Move Issues Between Installations |
| MIME::Parser |
5.406 |
Move Issues Between Installations |
| Chart::Base |
1.0 |
New Charts, Old Charts |
| Image::Magick |
(Any) |
Optionally Convert BMP Attachments to PNGs |
| PatchReader |
0.9.4 |
Patch Viewer |
| SOAP::Lite |
(Any) |
XML-RPC Interface |
| mod_perl2 |
1.999022 |
mod_perl |
| CGI |
3.11 |
mod_perl |
New Features and Improvements
Custom Fields
Cohere Reporting System now includes very basic support for custom fields.
Users in the admin group can add plain-text or drop-down
custom fields. You can edit the values available for drop-down fields
using the "Field Values" control panel.
Don't add too many custom fields! It can make Cohere Reporting System
very difficult to use. Try your best to get along with the default
fields, and then if you find that you can't live without custom fields
after a few weeks of using Cohere Reporting System, only then should you
start your custom fields.
mod_perl Support
Cohere Reporting System 3.0 supports mod_perl, which allows for extremely
enhanced page-load performance. mod_perl trades memory usage for performance,
allowing near-instantaneous page loads, but using much more memory.
If you want to enable mod_perl for your Cohere Reporting System, we recommend
a minimum of 1.5GB of RAM, and for a site with heavy traffic, 4GB to 8GB.
If performance isn't that critical on your installation, you don't
have the memory, or you are running some other web server than
Apache, Cohere Reporting System still runs perfectly as a normal CGI
application, as well.
Shared Saved Searches
Users can now choose to "share" their saved searches
with a certain group. That group will then be able to
"subscribe" to those searches, and have them appear
in their footer.
If the sharer can "bless" the group he's sharing to,
(that is, if he can add users to that group), it's considered
that he's a manager of that group, and his queries show up
automatically in that group's footer (although they can
unsubscribe from any particular search, if they want.)
In order to allow a user to share their queries, they also
have to be a member of the group specified in the
querysharegroup parameter.
Users can control their shared and subscribed queries from
the "Preferences" screen.
Attachments and Flags on New
Issues
You can now add an attachment while you are filing a new
issue.
You can also set flags on the issue and on attachments, while
filing a new issue.
Custom Resolutions
You can now customize the list of resolutions available
in Cohere Reporting System, including renaming the default resolutions.
The resolutions FIXED, DUPLICATE
and MOVED have a special meaning to Cohere Reporting System,
though, and cannot be renamed or deleted.
Per-Product Permissions
You can now grant users editbugs and canconfirm
for only certain products. You can also grant users editcomponents
on a product, which means they will be able to edit that product
including adding/removing components and other product-specific
controls.
User Interface Improvements
There has been some work on the user interface for Cohere Reporting System 3.0,
including:
- There is now navigation and a search box a the top of
each page, in addition to the bar at the bottom of the page.
- A re-designed "Format for Printing" page for
issues.
- The layout of show_bug.cgi (the issue editing
page) has been changed, and the attachment table has been redesigned.
XML-RPC Interface
Cohere Reporting System now has a Web Services interface using the XML-RPC
protocol. It can be accessed by external applications by going
to the xmlrpc.cgi on your installation.
Documentation can be found in the
Cohere Reporting System
API Docs, in the various Bugzilla::WebService modules.
Skins
Cohere Reporting System can have multiple "skins" installed,
and users can pick between them. To write a skin, you just have to
write several CSS files. See the Custom
Skins Documentation for more details.
We currently don't have any alternate skins shipping with
Cohere Reporting System. If you write an alternate skin, please
let us know!
Unchangeable Fields Appear
Unchangeable
As long as you are logged in, when viewing an Issue, if you
cannot change a field, it will not look like you can change it. That
is, the value will just appear as plain text.
All Emails in Templates
All outbound emails are now controlled by the templating system.
What used to be the passwordmail, whinemail,
newchangedmail and voteremovedmail
parameters are now all templates in the template/ directory.
This means that it's now much easier to customize your outbound
emails, and it's also possible for localizers to have more
localized emails as part of their language packs, if they want.
We also added a mailfrom parameter to let you set
who shows up in the From field on all emails that
Cohere Reporting System sends.
No More Double-Filed Issues
Users of Cohere Reporting System will sometimes accidentally submit
an Issue twice, either by going back in their web browser,
or just by refreshing a page. In the past, this could file the same
issue twice (or even three times) in a row, irritating
developers and confusing users.
Now, if you try to submit an Issue twice from the same screen
(by going back or by refreshing the page), Cohere Reporting System will warn
you about what you're doing, before it actually submits the duplicate
issue.
Default CC List for Components
You can specify a list of users who will always be added to
the CC list of new issues in a component.
File/Modify Issues By Email
You can now file or modify issues via email. Previous versions
of Cohere Reporting System included this feature only as an
unsupported add-on, but it is now an official interface to
Cohere Reporting System.
For more details see the documentation
for email_in.pl.
Users Who Get All Issue
Notifications
There is now a parameter called globalwatchers. This
is a comma-separated list of Cohere Reporting System users who will
get all issue notifications generated by Cohere Reporting System.
Group controls still apply, though, so users who can't see an Issue
still won't get notifications about that issue.
Improved UTF-8 Support
Cohere Reporting System users running MySQL should now have excellent
UTF-8 support if they turn on the utf8 parameter. (New
installs have this parameter on by default.) Cohere Reporting System
now correctly supports searching and sorting in non-English languages,
including multi-bytes languages such as Chinese.
Automatic Update Notification
If you belong to the admin group, you will be notified
when you log in if there is a new release of Cohere Reporting System
available to download.
You can control these notifications by changing the
upgrade_notification parameter.
If your Cohere Reporting System installation is on a machine that needs to go
through a proxy to access the web, you may also have to set the
proxy_url parameter.
Welcome Page for New Installs
When you log in for the first time on a brand-new Cohere Reporting System
installation, you will be presented with a page that describes
where you should go from here, and what parameters you should set.
QuickSearch Plugin for IE7 and Firefox 2
Firefox 2 users and Internet Explorer 7 users will be presented
with the option to add Cohere Reporting System to their search bar.
This uses the
QuickSearch syntax.
Other Enhancements and Changes
These are either minor enhancements, or enhancements that have
very short descriptions. Some of these are very useful, though!
Enhancements That Affect Cohere Reporting System Users
- In comments, quoted text (lines that start with >)
will be a different color from normal text.
- There is now a user preference that will add you to the CC list
of any issue you modify. Note that it's on
by default.
- Issues can now be filed with an initial state of
ASSIGNED, if you are in the editbugs group.
- By default, comment fields will zoom large when you are typing in them,
and become small when you move out of them. You can disable this
in your user preferences.
- You can hide obsolete attachments on an Issue by clicking
"Hide Obsolete" at the bottom of the attachment table.
- If an Issue has flags set, and you move it to a different
product that has flags with the same name, the flags will be
preserved.
- You now can't request a flag to be set by somebody who can't set it
(Cohere Reporting System will throw an error if you try).
- Many new headers have been added to outbound Cohere Reporting System
issue emails:
X-Bugzilla-Status,
X-Bugzilla-Priority, X-Bugzilla-Assigned-To,
X-Bugzilla-Target-Milestone, and
X-Bugzilla-Changed-Fields, X-Bugzilla-Who.
You can look at an email to get an idea of what they contain.
- In addition to the old
X-Bugzilla-Reason email header
which tells you why you got an email, if you got an email because
you were watching somebody, there is now an
X-Bugzilla-Watch-Reason header that tells you who you
were watching and what role they had.
- If you hover your mouse over a full URL (like
http://bugs.mycompany.com/show_bug.cgi?id=1212) that
links to an Issue, you will see the title of the
issue. Of course, this only works for issues in your
Cohere Reporting System installation.
- If your installation has user watching enabled, you will now see
the users that you can remove from your watch-list as a multi-select
box, much like the current CC list. (Previously it was just a text
box.)
- When a user creates their own account in Cohere Reporting System, the
account is now not actually created until they verify their email
address by clicking on a link that is emailed to them.
- You can change an Issue's resolution without reopening it.
- When you view the dependency tree on an Issue, resolved
issues will be hidden by default. (In previous versions,
resolved issues were shown by default.)
- When viewing issue activity, fields that hold issue
numbers (such as "Blocks") will have the issue numbers
displayed as links to those issues.
- When viewing the "Keywords" field in an Issue list,
it will be sorted alphabetically, so you can sanely sort a list on
that field.
- In most places, the Version field is now sorted using a version-sort
(so 1.10 is greater than 1.2) instead of an alphabetical sort.
- Options for flags will only appear if you can set them. So, for
example, if you can't grant + on a flag, that option
won't appear for you.
- You can limit the product-related output of config.cgi
by specifying a product= URL argument, containing the name
of a product. You can specify the argument more than once for multiple
products.
- You can now search the boolean charts on whether or not a comment
is private.
Enhancements For Administrators
- Administrators can now delete attachments, making them disappear
entirely from Cohere Reporting System.
- sanitycheck.cgi can now only be accessed by users
in the editcomponents group.
- The "Field Values" control panel can now only be accessed
by users in the admin group. (Previously it was accessible
to anybody in the editcomponents group.)
- There is a new parameter announcehtml, that will allow
you to enter some HTML that will be displayed at the top of every
page, as an announcement.
- The loginnetmask parameter now defaults to 0 for new
installations, meaning that as long as somebody has the right
login cookie, they can log in from any IP address. This makes
life a lot easier for dial-up users or other users whose IP
changes a lot. This could be done because the login cookie is now
very random, and thus secure.
- Classifications now have sortkeys, so they can be sorted in an
order that isn't alphabetical.
- Authentication now supports LDAP over SSL (LDAPS) or TLS (using
the STARTLS command) in addition to plain LDAP.
- LDAP users can have their LDAP username be their email address,
instead of having the LDAP mail attribute be their
email address. You may wish to set the emailsuffix
parameter if you do this.
- Administrators can now see what has changed in a user account,
when using the "Users" control panel.
REMIND and LATER are no longer part
of the default list of resolutions. Upgrading installations will
not be affected--they will still have these resolutions.- editbugs is now the default for the timetrackinggroup
parameter, meaning that time-tracking will be on by default in a new
installation.
Outstanding Issues
- Issue 69621: If you rename or remove a keyword that is
in use on issues, you will need to rebuild the "keyword cache"
by running sanitycheck.cgi and choosing
the option to rebuild the cache when it asks. Otherwise keywords may
not show up properly in search results.
- Issue 99215: Flags are not protected by "mid-air
collision" detection. Nor are any attachment changes.
- Issue 89822: When changing multiple issues at
the same time, there is no "mid-air collision" protection.
- Issue 276230: The support for restricting access to
particular Categories of New Charts is not complete. You should treat
the 'chartgroup' Param as the only access mechanism available.
However, charts migrated from Old Charts will be restricted to
the groups that are marked MANDATORY for the corresponding Product.
There is currently no way to change this restriction, and the
groupings will not be updated if the group configuration
for the Product changes.
- Issue 370370: mod_perl support is currently not
working on Windows machines.
- Issue 361149: If you are using Perl 5.8.0, you may
get a lot of warnings in your Apache error_log about "deprecated
pseudo-hashes." These are harmless--they are a bug in
Perl 5.8.0. Perl 5.8.1 and later do not have this problem.
- Cohere Reporting System 3.0rc1 allowed custom field column names in
the database to be mixed-case. Cohere Reporting System 3.0 only allows
lowercase column names. It will fix any column names that you have
made mixed-case, but if you have custom fields that previously were
mixed-case in any Saved Search, you will have to re-create that Saved
Search yourself.
Security Updates in This Release
3.0.6
Cohere Reporting System contains a minor security fix. For details, see the
Security Advisory.
3.0.5
Cohere Reporting System contains one security fix for
importxml.pl.
For details, see the
Security Advisory.
3.0.4
Cohere Reporting System 3.0.4 contains three security fixes.
For details, see the
Security Advisory.
3.0.3
No security fixes in this release.
3.0.2
Cohere Reporting System 3.0.1 had an important security fix that is
critical for public installations with "requirelogin" turned on.
For details, see the
Security Advisory
3.0.1
Cohere Reporting System 3.0 had three security issues that have been
fixed in this release: one minor information leak, one hole only
exploitable by an admin or using email_in.pl, and one in an
uncommonly-used template. For details, see the
Security Advisory.
How to Upgrade From An Older Version
Notes For Upgraders
- If you upgrade by CVS, there are several .cvsignore files
that are now in CVS instead of being locally created by
checksetup.pl. This means that you will have to
delete those files when CVS tells you there's a conflict, and
then run cvs update again.
- In this version of Cohere Reporting System, the Summary field
is now limited to 255 characters. When you upgrade, any Summary
longer than that will be truncated, and the old summary will be
preserved in a comment.
- If you have the utf8 parameter turned on, at some
point you will have to convert your database. checksetup.pl
will tell you when this is, and it will give you certain instructions
at that time, that you have to follow before you can complete
the upgrade. Don't do the conversion yourself manually--follow
the instructions of checksetup.pl.
- If you ever ran 2.23.3, 2.23.4, or 3.0rc1, you will have to run
./collectstats.pl --regenerate at the command line, because
the data for your Old Charts is corrupted. This can take several days,
so you may only want to run it if you use Old Charts.
- You should also read the Outstanding Issues sections of
older release notes if you are upgrading
from a version lower than 2.22.
Steps For Upgrading
Once you have read the notes above, see the
Upgrading
documentation for instructions on how to upgrade.
Code Changes Which May Affect
Customizations
Packagers: Location
Variables Have Moved
In previous versions of Cohere Reporting System, Bugzilla::Config
held all the paths for different things, such as the path to localconfig
and the path to the data/ directory.
Now, all of this data is stored in a subroutine,
Bugzilla::Constants::bz_locations.
Also, note that for mod_perl, bz_locations must return
absolute (not relative) paths. There is already code in that
subroutine to help you with this.
Hooks!
Cohere Reporting System now supports a code hook mechanism. See the
documentation for
Bugzilla::Hook
for more details.
This gives Cohere Reporting System very advanced plugin support. You can
hook templates, hook code, add new parameters, and use the XML-RPC
interface. So we'd like to see some Cohere Reporting System plugins
written! Let us know on the developers@bugzilla.org
mailing list if you write a plugin.
If you need more hooks, please
File a bug!
API Documentation
Cohere Reporting System now ships with all of its perldoc built
as HTML. Go ahead and read the
API Documentation
for all of the Cohere Reporting System modules now! Even scripts like
checksetup.pl have HTML documentation.
Elimination of globals.pl
The old file globals.pl has been eliminated.
Its code is now in various modules. Each function went to the module
that was appropriate for it.
Usually we filed an Issue in
bugzilla.mozilla.org for
each function we moved. You can search there for the old name of
the function, and that should get you the information about what
it's called now and where it lives.
Cleaned Up Variable Scoping Issues
In normal perl, you can have code like this:
my $var = 0;
sub y { $var++ }
However, under mod_perl that doesn't work. So variables are no
longer "shared" with subroutines--instead all variables
that a subroutine needs must be declared inside the subroutine itself.
No More SendSQL
The old SendSQL function and all of its companions are
gone. Instead, we now use DBI for all database
interaction.
For more information about how to use
DBI with
Cohere Reporting System, see the
Developer's
Guide Section About DBI
Auth Re-write
The Bugzilla::Auth family of modules have been completely
re-written. For details on how the new structure of authentication,
read the
Bugzilla::Auth
API docs.
It should be very easy to write new authentication plugins, now.
Bugzilla::Object
There is a new base class for most of our objects,
Bugzilla::Object.
It makes it really easy to create new objects based on things that are
in the database.
Bugzilla->request-cache
Bugzilla.pm used to cache things like the database
connection in package-global variables (like $_dbh).
That doesn't work in mod_perl, so instead now there's a hash
that can be accessed through Bugzilla->request_cache
to store things for the rest of the current page request.
You shouldn't access Bugzilla->request_cache directly,
but you should use it inside of Bugzilla.pm if you modify
that. The only time you should be accessing it directly is if you need
to reset one of the caches. Hash keys are always named after the function
that they cache, so to reset the template object, you'd do:
delete Bugzilla->request_cache->{template};.
Other Changes
checksetup.pl has been completely re-written, and most
of its code moved into modules in the Bugzilla::Install
namespace. See the
checksetup
documentation and Cohere Reporting System
issue 277502 for details.- Instead of UserInGroup(), all of Cohere Reporting System now
uses Bugzilla->user->in_group
- mod_perl doesn't like dependency loops in modules, so we now have
a test for that detects dependency loops in modules when you run
runtests.pl.
- globals.pl used to modify the environment variables,
like PATH. That now happens in Bugzilla.pm.
- Templates can now link to the documentation more easily.
See the global/code-error.html.tmpl and
global/user-error.html.tmpl templates for examples.
(Search for "docslinks.")
- Parameters are accessed through Bugzilla->params
instead of using the Param() function, now.
- The variables from the localconfig file are accessed
through the
Bugzilla->localconfig hash instead of through
Bugzilla::Config.
- Bugzilla::BugMail::MessageToMTA() has moved into its
own module, along with other mail-handling code, called
Bugzilla::Mailer
- The CheckCanChangeField() subroutine in
process_bug.cgi has been moved to Bugzilla::Bug,
and is now a method of an Issue object.
- The code that used to be in the global/banner.html.tmpl
template is now in global/header.html.tmpl. The banner
still exists, but the file is empty.
Release Notes For Previous Versions
Release notes for versions of Cohere Reporting System for versions
prior to 3.0 are only available in text format:
Release Notes for Cohere Reporting System 2.22
and Earlier.