Commit d495a972 authored by Max Kanat-Alexander's avatar Max Kanat-Alexander

Fix the data in the bzr repo to match the data in the CVS repo.

During the CVS imports into Bzr, there were some inconsistencies introduced (mostly that files that were deleted in CVS weren't being deleted in Bzr). So this checkin makes the bzr repo actually consistent with the CVS repo, including fixing permissions of files.
parent a456dea4
File mode changed from 100755 to 100644
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Terry Weissman <terry@mozilla.org>
# Dawn Endico <endico@mozilla.org>
# Dan Mosedale <dmose@mozilla.org>
# Joe Robins <jmrobins@tgix.com>
# Jacob Steenhagen <jake@bugzilla.org>
# J. Paul Reed <preed@sigkill.com>
# Bradley Baetz <bbaetz@student.usyd.edu.au>
# Joseph Heenan <joseph@heenan.me.uk>
# Erik Stambaugh <erik@dasbistro.com>
# Frédéric Buclin <LpSolit@gmail.com>
#
package Bugzilla::Config::L10n;
use strict;
use File::Spec; # for find_languages
use Bugzilla::Constants;
use Bugzilla::Config::Common;
$Bugzilla::Config::L10n::sortkey = "08";
sub get_param_list {
my $class = shift;
my @param_list = (
{
name => 'languages' ,
extra_desc => { available_languages => find_languages() },
type => 't' ,
default => 'en' ,
checker => \&check_languages
} );
return @param_list;
}
sub find_languages {
my @languages = ();
opendir(DIR, bz_locations()->{'templatedir'})
|| return "Can't open 'template' directory: $!";
foreach my $dir (readdir(DIR)) {
next unless $dir =~ /^([a-z-]+)$/i;
my $lang = $1;
next if($lang =~ /^CVS$/i);
my $deft_path = File::Spec->catdir('template', $lang, 'default');
my $cust_path = File::Spec->catdir('template', $lang, 'custom');
push(@languages, $lang) if(-d $deft_path or -d $cust_path);
}
closedir DIR;
return join(', ', @languages);
}
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Marc Schumann.
# Portions created by Marc Schumann are Copyright (C) 2008 Marc Schumann.
# All Rights Reserved.
#
# Contributor(s): Marc Schumann <wurblzap@gmail.com>
package Bugzilla::Template::Parser;
use strict;
use base qw(Template::Parser);
sub parse {
my ($self, $text, @params) = @_;
if (Bugzilla->params->{'utf8'}) {
utf8::is_utf8($text) || utf8::decode($text);
}
return $self->SUPER::parse($text, @params);
}
1;
__END__
=head1 NAME
Bugzilla::Template::Parser - Wrapper around the Template Toolkit
C<Template::Parser> object
=head1 DESCRIPTION
This wrapper makes the Template Toolkit aware of UTF-8 templates.
=head1 SUBROUTINES
=over
=item C<parse($options)>
Description: Parses template text using Template::Parser::parse(),
converting the text to UTF-8 encoding before, if necessary.
Params: C<$text> - Text to pass to Template::Parser::parse().
Returns: Parsed text as returned by Template::Parser::parse().
=back
=head1 SEE ALSO
L<Template>
File mode changed from 100755 to 100644
File mode changed from 100755 to 100644
File mode changed from 100755 to 100644
Bugzilla Quick Start Guide
==========================
(or, how to get Bugzilla up and running in 10 steps)
Christian Reis <kiko@async.com.br>
This express installation guide is for "normal" Bugzilla installations,
which means a Linux or Unix system on which Apache, Perl, MySQL or PostgreSQL
and a Sendmail compatible MTA are available. For other configurations, please
see Section 4 of the Bugzilla Guide in the docs/ directory.
1. Decide from which URL and directory under your webserver root you
will be serving the Bugzilla webpages.
2. Unpack the distribution into the chosen directory (there is no copying or
installation involved).
3. Run ./checksetup.pl, look for unsolved requirements, and install them.
You can run checksetup as many times as necessary to check if
everything required has been installed.
These will usually include assorted Perl modules, MySQL or PostgreSQL,
and a MTA.
After a successful dependency check, checksetup should complain that
localconfig needs to be edited.
4. Edit the localconfig file, in particular the $webservergroup and
$db_* variables. In particular, $db_name and $db_user will define
your database setup in step 5.
5. Using the name you provided as $db_name above, create a MySQL database
for Bugzilla. You should also create a user permission for the name
supplied as $db_user with read/write access to that database.
If you are not familiar with MySQL permissions, it's a good idea to
use the mysql_setpermission script that is installed with the MySQL
distribution, and be sure to read Bugzilla Security - MySQL section
in the Bugzilla Guide or PostgreSQL documentation.
6. Run checksetup.pl once more; if all goes well, it should set up the
Bugzilla database for you. If not, return to step 5.
checksetup.pl should ask you, this time, for the administrator's
email address and password. These will be used for the initial
Bugzilla administrator account.
7. Configure Apache (or install and configure, if you don't have it up
yet) to point to the Bugzilla directory. You should enable and
activate mod_cgi, and add the configuration entries
Options +ExecCGI
AllowOverride Limit
DirectoryIndex index.cgi
to your Bugzilla <Directory> block. You may also need
AddHandler cgi-script .cgi
if you don't have that in your Apache configuration file yet.
8. Visit the URL you chose for Bugzilla. Your browser should display the
default Bugzilla home page. You should then log in as the
administrator by following the "Log in" link and supplying the
account information you provided in step 6.
9. Scroll to the bottom of the page after logging in, and select
"Parameters". Set up the relevant parameters for your local setup.
See section 4.2 of the Bugzilla Guide for a in-depth description of
some of the configuration parameters available.
10. That's it. If anything unexpected comes up:
- read the error message carefully,
- backtrack through the steps above,
- check the official installation guide, which is section 4 in the
Bugzilla Guide, included in the docs/ directory in various
formats.
Support and installation questions should be directed to the
mozilla-webtools@mozilla.org mailing list -- don't write to the
developer mailing list: your post *will* be ignored if you do.
Further support information is at http://www.bugzilla.org/support/
Please consult The Bugzilla Guide for instructions on how to upgrade
Bugzilla from an older version. The Guide can be found with this
distribution, in docs/html, docs/txt, and docs/sgml.
This file contains only important changes made to Bugzilla before release
2.8. If you are upgrading from version older than 2.8, please read this file.
If you are upgrading from 2.8 or newer, please read the Installation and
Upgrade instructions in The Bugzilla Guide, found with this distribution in
docs/html, docs/txt, and docs/sgml.
Please note that the period in our version numbers is a place separator, not
a decimal point. The 14 in version 2.14 is newer than the 8 in 2.8, for
example. You should only be using this file if you have a single digit
after the period in the version 2.x Bugzilla you are upgrading from.
For a complete list of what changes, use Bonsai
(http://cvs-mirror.mozilla.org/webtools/bonsai/cvsqueryform.cgi) to
query the CVS tree. For example,
http://cvs-mirror.mozilla.org/webtools/bonsai/cvsquery.cgi?module=all&branch=HEAD&branchtype=match&dir=mozilla%2Fwebtools%2Fbugzilla&file=&filetype=match&who=&whotype=match&sortby=Date&hours=2&date=week&mindate=&maxdate=&cvsroot=%2Fcvsroot
will tell you what has been changed in the last week.
10/12/99 The CHANGES file is now obsolete! There is a new file called
checksetup.pl. You should get in the habit of running that file every time
you update your installation of Bugzilla. That file will be constantly
updated to automatically update your installation to match any code changes.
If you're curious as to what is going on, changes are commented in that file,
at the end.
Many thanks to Holger Schurig <holgerschurig@nikocity.de> for writing this
script!
10/11/99 Restructured voting database to add a cached value in each
bug recording how many total votes that bug has. While I'm at it, I
removed the unused "area" field from the bugs database. It is
distressing to realize that the bugs table has reached the maximum
number of indices allowed by MySQL (16), which may make future
enhancements awkward.
You must feed the following to MySQL:
alter table bugs drop column area;
alter table bugs add column votes mediumint not null, add index (votes);
You then *must* delete the data/versioncache file when you make this
change, as it contains references to the "area" field. Deleting it is safe,
bugzilla will correctly regenerate it.
If you have been using the voting feature at all, then you will then
need to update the voting cache. You can do this by visiting the
sanitycheck.cgi page, and taking it up on its offer to rebuild the
votes stuff.
10/7/99 Added voting ability. You must run the new script
"makevotestable.sh". You must also feed the following to mysql:
alter table products add column votesperuser smallint not null;
9/15/99 Apparently, newer alphas of MySQL won't allow you to have
"when" as a column name. So, I have had to rename a column in the
bugs_activity table. You must feed the below to mysql or you won't
work at all.
alter table bugs_activity change column when bug_when datetime not null;
8/16/99 Added "OpenVMS" to the list of OS's. Feed this to mysql:
alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "Mac System 8.6", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "FreeBSD", "OSF/1", "Solaris", "SunOS", "Neutrino", "OS/2", "BeOS", "OpenVMS", "other") not null;
6/22/99 Added an entry to the attachments table to record who the submitter
was. Nothing uses this yet, but it still should be recorded.
alter table attachments add column submitter_id mediumint not null;
You should also run this script to populate the new field:
#!/usr/bin/perl -w
use diagnostics;
use strict;
require "globals.pl";
$|=1;
ConnectToDatabase();
SendSQL("select bug_id, attach_id from attachments order by bug_id");
my @list;
while (MoreSQLData()) {
my @row = FetchSQLData();
push(@list, \@row);
}
foreach my $ref (@list) {
my ($bug, $attach) = (@$ref);
SendSQL("select long_desc from bugs where bug_id = $bug");
my $comment = FetchOneColumn() . "Created an attachment (id=$attach)";
if ($comment =~ m@-* Additional Comments From ([^ ]*)[- 0-9/:]*\nCreated an attachment \(id=$attach\)@) {
print "Found $1\n";
SendSQL("select userid from profiles where login_name=" .
SqlQuote($1));
my $userid = FetchOneColumn();
if (defined $userid && $userid > 0) {
SendSQL("update attachments set submitter_id=$userid where attach_id = $attach");
}
} else {
print "Bug $bug can't find comment for attachment $attach\n";
}
}
6/14/99 Added "BeOS" to the list of OS's. Feed this to mysql:
alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "Mac System 8.6", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "FreeBSD", "OSF/1", "Solaris", "SunOS", "Neutrino", "OS/2", "BeOS", "other") not null;
5/27/99 Added support for dependency information. You must run the new
"makedependenciestable.sh" script. You can turn off dependencies with the new
"usedependencies" param, but it defaults to being on. Also, read very
carefully the description for the new "webdotbase" param; you will almost
certainly need to tweak it.
5/24/99 Added "Mac System 8.6" and "Neutrino" to the list of OS's.
Feed this to mysql:
alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "Mac System 8.6", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "FreeBSD", "OSF/1", "Solaris", "SunOS", "Neutrino", "OS/2", "other") not null;
5/12/99 Added a pref to control how much email you get. This needs a new
column in the profiles table, so feed the following to mysql:
alter table profiles add column emailnotification enum("ExcludeSelfChanges", "CConly", "All") not null default "ExcludeSelfChanges";
5/5/99 Added the ability to search by creation date. To make this perform
well, you ought to do the following:
alter table bugs change column creation_ts creation_ts datetime not null, add index (creation_ts);
4/30/99 Added a new severity, "blocker". To get this into your running
Bugzilla, do the following:
alter table bugs change column bug_severity bug_severity enum("blocker", "critical", "major", "normal", "minor", "trivial", "enhancement") not null;
4/22/99 There was a bug where the long descriptions of bugs had a variety of
newline characters at the end, depending on the operating system of the browser
that submitted the text. This bug has been fixed, so that no further changes
like that will happen. But to fix problems that have already crept into your
database, you can run the following perl script (which is slow and ugly, but
does work:)
#!/usr/bin/perl -w
use diagnostics;
use strict;
require "globals.pl";
$|=1;
ConnectToDatabase();
SendSQL("select bug_id from bugs order by bug_id");
my @list;
while (MoreSQLData()) {
push(@list, FetchOneColumn());
}
foreach my $id (@list) {
if ($id % 50 == 0) {
print "\n$id ";
}
SendSQL("select long_desc from bugs where bug_id = $id");
my $comment = FetchOneColumn();
my $orig = $comment;
$comment =~ s/\r\n/\n/g; # Get rid of windows-style line endings.
$comment =~ s/\r/\n/g; # Get rid of mac-style line endings.
if ($comment ne $orig) {
SendSQL("update bugs set long_desc = " . SqlQuote($comment) .
" where bug_id = $id");
print ".";
} else {
print "-";
}
}
4/8/99 Added ability to store patches with bugs. This requires a new table
to store the data, so you will need to run the "makeattachmenttable.sh" script.
3/25/99 Unfortunately, the HTML::FromText CPAN module had too many bugs, and
so I had to roll my own. We no longer use the HTML::FromText CPAN module.
3/24/99 (This entry has been removed. It used to say that we required the
HTML::FromText CPAN module, but that's no longer true.)
3/22/99 Added the ability to query by fields which have changed within a date
range. To make this perform a bit better, we need a new index:
alter table bugs_activity add index (field);
3/10/99 Added 'groups' stuff, where we have different group bits that we can
put on a person or on a bug. Some of the group bits control access to bugzilla
features. And a person can't access a bug unless he has every group bit set
that is also set on the bug. See the comments in makegroupstable.sh for a bit
more info.
The 'maintainer' param is now used only as an email address for people to send
complaints to. The groups table is what is now used to determine permissions.
You will need to run the new script "makegroupstable.sh". And then you need to
feed the following lines to MySQL (replace XXX with the login name of the
maintainer, the person you wish to be all-powerful).
alter table bugs add column groupset bigint not null;
alter table profiles add column groupset bigint not null;
update profiles set groupset=0x7fffffffffffffff where login_name = XXX;
3/8/99 Added params to control how priorities are set in a new bug. You can
now choose whether to let submitters of new bugs choose a priority, or whether
they should just accept the default priority (which is now no longer hardcoded
to "P2", but is instead a param.) The default value of the params will cause
the same behavior as before.
3/3/99 Added a "disallownew" field to the products table. If non-zero, then
don't let people file new bugs against this product. (This is for when a
product is retired, but you want to keep the bug reports around for posterity.)
Feed this to MySQL:
alter table products add column disallownew tinyint not null;
2/8/99 Added FreeBSD to the list of OS's. Feed this to MySQL:
alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "FreeBSD", "OSF/1", "Solaris", "SunOS", "OS/2", "other") not null;
2/4/99 Added a new column "description" to the components table, and added
links to a new page which will use this to describe the components of a
given product. Feed this to MySQL:
alter table components add column description mediumtext not null;
2/3/99 Added a new column "initialqacontact" to the components table that gives
an initial QA contact field. It may be empty if you wish the initial qa
contact to be empty. If you're not using the QA contact field, you don't need
to add this column, but you might as well be safe and add it anyway:
alter table components add column initialqacontact tinytext not null;
2/2/99 Added a new column "milestoneurl" to the products table that gives a URL
which is to describe the currently defined milestones for a product. If you
don't use target milestone, you might be able to get away without adding this
column, but you might as well be safe and add it anyway:
alter table products add column milestoneurl tinytext not null;
1/29/99 Whoops; had a misspelled op_sys. It was "Mac System 7.1.6"; it should
be "Mac System 7.6.1". It turns out I had no bugs with this value set, so I
could just do the below simple command. If you have bugs with this value, you
may need to do something more complicated.
alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.6.1", "Mac System 8.0", "Mac System 8.5", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "OSF/1", "Solaris", "SunOS", "OS/2", "other") not null;
1/20/99 Added new fields: Target Milestone, QA Contact, and Status Whiteboard.
These fields are all optional in the UI; there are parameters to turn them on.
However, whether or not you use them, the fields need to be in the DB. There
is some code that needs them, even if you don't.
To update your DB to have these fields, send the following to MySQL:
alter table bugs add column target_milestone varchar(20) not null,
add column qa_contact mediumint not null,
add column status_whiteboard mediumtext not null,
add index (target_milestone), add index (qa_contact);
1/18/99 You can now query by CC. To make this perform reasonably, the CC table
needs some indices. The following MySQL does the necessary stuff:
alter table cc add index (bug_id), add index (who);
1/15/99 The op_sys field can now be queried by (and more easily tweaked).
To make this perform reasonably, it needs an index. The following MySQL
command will create the necessary index:
alter table bugs add index (op_sys);
12/2/98 The op_sys and rep_platform fields have been tweaked. op_sys
is now an enum, rather than having the legal values all hard-coded in
perl. rep_platform now no longer allows a value of "X-Windows".
Here's how I ported to the new world. This ought to work for you too.
Actually, it's probably overkill. I had a lot of illegal values for op_sys
in my tables, from importing bugs from strange places. If you haven't done
anything funky, then much of the below will be a no-op.
First, send the following commands to MySQL to make sure all your values for
rep_platform and op_sys are legal in the new world..
update bugs set rep_platform="Sun" where rep_platform="X-Windows" and op_sys like "Solaris%";
update bugs set rep_platform="SGI" where rep_platform="X-Windows" and op_sys = "IRIX";
update bugs set rep_platform="SGI" where rep_platform="X-Windows" and op_sys = "HP-UX";
update bugs set rep_platform="DEC" where rep_platform="X-Windows" and op_sys = "OSF/1";
update bugs set rep_platform="PC" where rep_platform="X-Windows" and op_sys = "Linux";
update bugs set rep_platform="other" where rep_platform="X-Windows";
update bugs set rep_platform="other" where rep_platform="";
update bugs set op_sys="Mac System 7" where op_sys="System 7";
update bugs set op_sys="Mac System 7.5" where op_sys="System 7.5";
update bugs set op_sys="Mac System 8.0" where op_sys="8.0";
update bugs set op_sys="OSF/1" where op_sys="Digital Unix 4.0";
update bugs set op_sys="IRIX" where op_sys like "IRIX %";
update bugs set op_sys="HP-UX" where op_sys like "HP-UX %";
update bugs set op_sys="Windows NT" where op_sys like "NT %";
update bugs set op_sys="OSF/1" where op_sys like "OSF/1 %";
update bugs set op_sys="Solaris" where op_sys like "Solaris %";
update bugs set op_sys="SunOS" where op_sys like "SunOS%";
update bugs set op_sys="other" where op_sys = "Motif";
update bugs set op_sys="other" where op_sys = "Other";
Next, send the following commands to make sure you now have only legal
entries in your table. If either of the queries do not come up empty, then
you have to do more stuff like the above.
select bug_id,op_sys,rep_platform from bugs where rep_platform not regexp "^(All|DEC|HP|Macintosh|PC|SGI|Sun|X-Windows|Other)$";
select bug_id,op_sys,rep_platform from bugs where op_sys not regexp "^(All|Windows 3.1|Windows 95|Windows 98|Windows NT|Mac System 7|Mac System 7.5|Mac System 7.1.6|Mac System 8.0|AIX|BSDI|HP-UX|IRIX|Linux|OSF/1|Solaris|SunOS|other)$";
Finally, once that's all clear, alter the table to make enforce the new legal
entries:
alter table bugs change column op_sys op_sys enum("All", "Windows 3.1", "Windows 95", "Windows 98", "Windows NT", "Mac System 7", "Mac System 7.5", "Mac System 7.1.6", "Mac System 8.0", "AIX", "BSDI", "HP-UX", "IRIX", "Linux", "OSF/1", "Solaris", "SunOS", "other") not null, change column rep_platform rep_platform enum("All", "DEC", "HP", "Macintosh", "PC", "SGI", "Sun", "Other");
11/20/98 Added searching of CC field. To better support this, added
some indexes to the CC table. You probably want to execute the following
mysql commands:
alter table cc add index (bug_id);
alter table cc add index (who);
10/27/98 security check for legal products in place. bug charts are not
available as an option if collectstats.pl has never been run. all products
get daily stats collected now. README updated: Chart::Base is listed as
a requirement, instructions for using collectstats.pl included as
an optional step. also got silly and added optional quips to bug
reports.
10/17/98 modified README installation instructions slightly.
10/7/98 Added a new table called "products". Right now, this is used
only to have a description for each product, and that description is
only used when initially adding a new bug. Anyway, you *must* create
the new table (which you can do by running the new makeproducttable.sh
script). If you just leave it empty, things will work much as they
did before, or you can add descriptions for some or all of your
products.
9/15/98 Everything has been ported to Perl. NO MORE TCL. This
transition should be relatively painless, except for the "params"
file. This is the file that contains parameters you've set up on the
editparams.cgi page. Before changing to Perl, this was a tcl-syntax
file, stored in the same directory as the code; after the change to
Perl, it becomes a perl-syntax file, stored in a subdirectory named
"data". See the README file for more details on what version of Perl
you need.
So, if updating from an older version of Bugzilla, you will need to
edit data/param, change the email address listed for
$::param{'maintainer'}, and then go revisit the editparams.cgi page
and reset all the parameters to your taste. Fortunately, your old
params file will still be around, and so you ought to be able to
cut&paste important bits from there.
Also, note that the "whineatnews" script has changed name (it now has
an extension of .pl instead of .tcl), so you'll need to change your
cron job.
And the "comments" file has been moved to the data directory. Just do
"cat comments >> data/comments" to restore any old comments that may
have been lost.
9/2/98 Changed the way password validation works. We now keep a
crypt'd version of the password in the database, and check against
that. (This is silly, because we're also keeping the plaintext
version there, but I have plans...) Stop passing the plaintext
password around as a cookie; instead, we have a cookie that references
a record in a new database table, logincookies.
IMPORTANT: if updating from an older version of Bugzilla, you must run
the following commands to keep things working:
./makelogincookiestable.sh
echo "alter table profiles add column cryptpassword varchar(64);" | mysql bugs
echo "update profiles set cryptpassword = encrypt(password,substring(rand(),3, 4));" | mysql bugs
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
#!/usr/bin/perl -w
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Gnats To Bugzilla Conversion Utility.
#
# The Initial Developer of the Original Code is Tom
# Schutter. Portions created by Tom Schutter are
# Copyright (C) 1999 Tom Schutter. All
# Rights Reserved.
#
# Contributor(s): Tom Schutter <tom@platte.com>
#
# Perl script to convert a GNATS database to a Bugzilla database.
# This script generates a file that contains SQL commands for MySQL.
# This script DOES NOT MODIFY the GNATS database.
# This script DOES NOT MODIFY the Bugzilla database.
#
# Usage procedure:
# 1) Regenerate the GNATS index file. It sometimes has inconsistencies,
# and this script relies on it being correct. Use the GNATS command:
# gen-index --numeric --outfile=$GNATS_DIR/gnats-db/gnats-adm/index
# 2) Modify variables at the beginning of this script to match
# what your site requires.
# 3) Modify translate_pr() and write_bugs() below to fixup mapping from
# your GNATS policies to Bugzilla. For example, how do the
# Severity/Priority fields map to bug_severity/priority?
# 4) Run this script.
# 5) Fix the problems in the GNATS database identified in the output
# script file gnats2bz_cleanup.sh. Fixing problems may be a job
# for a custom perl script. If you make changes to GNATS, goto step 2.
# 6) Examine the statistics in the output file gnats2bz_stats.txt.
# These may indicate some more cleanup that is needed. For example,
# you may find that there are invalid "State"s, or not a consistent
# scheme for "Release"s. If you make changes to GNATS, goto step 2.
# 7) Examine the output data file gnats2bz_data.sql. If problems
# exist, goto step 2.
# 8) Create a new, empty Bugzilla database.
# 9) Import the data using the command:
# mysql -uroot -p'ROOT_PASSWORD' bugs < gnats2bz_data.sql
# 10) Update the shadow directory with the command:
# cd $BUGZILLA_DIR; ./processmail regenerate
# 11) Run a sanity check by visiting the sanitycheck.cgi page.
# 12) Manually verify that the database is ok. If it is not, goto step 2.
#
# Important notes:
# Confidential is not mapped or exported.
# Submitter-Id is not mapped or exported.
#
# Design decisions:
# This script generates a SQL script file rather than dumping the data
# directly into the database. This is to allow the user to check
# and/or modify the results before they are put into the database.
# The PR number is very important and must be maintained as the Bugzilla
# bug number, because there are many references to the PR number, such
# as in code comments, CVS comments, customer communications, etc.
# Reading ENUMERATED and TEXT fields:
# 1) All leading and trailing whitespace is stripped.
# Reading MULTITEXT fields:
# 1) All leading blank lines are stripped.
# 2) All trailing whitespace is stripped.
# 3) Indentation is preserved.
# Audit-Trail is not mapped to bugs_activity table, because there
# is no place to put the "Why" text, which can have a fair amount
# of information content.
#
# 15 January 2002 - changes from Andrea Dell'Amico <adellam@link.it>
#
# * Adapted to the new database structure: now long_descs is a
# separate table.
# * Set a default for the target milestone, otherwise bugzilla
# doesn't work with the imported database if milestones are used.
# * In gnats version 3.113 records are separated by "|" and not ":".
# * userid "1" is for the bugzilla administrator, so it's better to
# start from 2.
#
use strict;
# Suffix to be appended to username to make it an email address.
my($username_suffix) = "\@platte.com";
# Default organization that should be ignored and not passed on to Bugzilla.
# Only bugs that are reported outside of the default organization will have
# their Originator,Organization fields passed on.
# The assumption here is that if the Organization is identical to the
# $default_organization, then the Originator will most likely be only an
# alias for the From field in the mail header.
my($default_organization) = "Platte River Associates|platte";
# Username for reporter field if unable to determine from mail header
my($gnats_username) = "gnats\@platte.com";
# Flag indicating if cleanup file should use edit-pr or ${EDITOR}.
# Using edit-pr is safer, but may be too slow if there are too many
# PRs that need cleanup. If you use ${EDITOR}, then you must make
# sure that you have exclusive access to the database, and that you
# do not screw up any fields.
my($cleanup_with_edit_pr) = 0;
# Component name and description for bugs imported from GNATS.
my($default_component) = "GNATS Import";
my($default_component_description) = "Bugs imported from GNATS.";
# First generated userid. Start from 2: 1 is used for the bugzilla
# administrator.
my($userid_base) = 2;
# Output filenames.
my($cleanup_pathname) = "gnats2bz_cleanup.sh";
my($stats_pathname) = "gnats2bz_stats.txt";
my($data_pathname) = "gnats2bz_data.sql";
# List of ENUMERATED and TEXT fields.
my(@text_fields) = qw(Number Category Synopsis Confidential Severity
Priority Responsible State Class Submitter-Id
Arrival-Date Originator Release);
# List of MULTITEXT fields.
my(@multitext_fields) = qw(Mail-Header Organization Environment Description
How-To-Repeat Fix Audit-Trail Unformatted);
# List of fields to report statistics for.
my(@statistics_fields) = qw(Category Confidential Severity Priority
Responsible State Class Submitter-Id Originator
Organization Release Environment);
# Array to hold list of GNATS PRs.
my(@pr_list);
# Array to hold list of GNATS categories.
my(@categories_list);
# Array to hold list of GNATS responsible users.
my(@responsible_list);
# Array to hold list of usernames.
my(@username_list);
# Put the gnats_username in first.
get_userid($gnats_username);
# Hash to hold list of versions.
my(%versions_table);
# Hash to hold contents of PR.
my(%pr_data);
# String to hold duplicate fields found during read of PR.
my($pr_data_dup_fields) = "";
# String to hold badly labeled fields found during read of PR.
# This usually happens when the user does not separate the field name
# from the field data with whitespace.
my($pr_data_bad_fields) = " ";
# Hash to hold statistics (note that this a hash of hashes).
my(%pr_stats);
# Process commmand line.
my($gnats_db_dir) = @ARGV;
defined($gnats_db_dir) || die "gnats-db dir not specified";
(-d $gnats_db_dir) || die "$gnats_db_dir is not a directory";
# Load @pr_list from GNATS index file.
my($index_pathname) = $gnats_db_dir . "/gnats-adm/index";
(-f $index_pathname) || die "$index_pathname not found";
print "Reading $index_pathname...\n";
if (!load_index($index_pathname)) {
return(0);
}
# Load @category_list from GNATS categories file.
my($categories_pathname) = $gnats_db_dir . "/gnats-adm/categories";
(-f $categories_pathname) || die "$categories_pathname not found";
print "Reading $categories_pathname...\n";
if (!load_categories($categories_pathname)) {
return(0);
}
# Load @responsible_list from GNATS responsible file.
my($responsible_pathname) = $gnats_db_dir . "/gnats-adm/responsible";
(-f $responsible_pathname) || die "$responsible_pathname not found";
print "Reading $responsible_pathname...\n";
if (!load_responsible($responsible_pathname)) {
return(0);
}
# Open cleanup file.
open(CLEANUP, ">$cleanup_pathname") ||
die "Unable to open $cleanup_pathname: $!";
chmod(0744, $cleanup_pathname) || warn "Unable to chmod $cleanup_pathname: $!";
print CLEANUP "#!/bin/sh\n";
print CLEANUP "# List of PRs that have problems found by gnats2bz.pl.\n";
# Open data file.
open(DATA, ">$data_pathname") || die "Unable to open $data_pathname: $!";
print DATA "-- Exported data from $gnats_db_dir by gnats2bz.pl.\n";
print DATA "-- Load it into a Bugzilla database using the command:\n";
print DATA "-- mysql -uroot -p'ROOT_PASSWORD' bugs < gnats2bz_data.sql\n";
print DATA "--\n";
# Loop over @pr_list.
my($pr);
foreach $pr (@pr_list) {
print "Processing $pr...\n";
if (!read_pr("$gnats_db_dir/$pr")) {
next;
}
translate_pr();
check_pr($pr);
collect_stats();
update_versions();
write_bugs();
write_longdescs();
}
write_non_bugs_tables();
close(CLEANUP) || die "Unable to close $cleanup_pathname: $!";
close(DATA) || die "Unable to close $data_pathname: $!";
print "Generating $stats_pathname...\n";
report_stats();
sub load_index {
my($pathname) = @_;
my($record);
my(@fields);
open(INDEX, $pathname) || die "Unable to open $pathname: $!";
while ($record = <INDEX>) {
@fields = split(/\|/, $record);
push(@pr_list, $fields[0]);
}
close(INDEX) || die "Unable to close $pathname: $!";
return(1);
}
sub load_categories {
my($pathname) = @_;
my($record);
open(CATEGORIES, $pathname) || die "Unable to open $pathname: $!";
while ($record = <CATEGORIES>) {
if ($record =~ /^#/) {
next;
}
push(@categories_list, [split(/:/, $record)]);
}
close(CATEGORIES) || die "Unable to close $pathname: $!";
return(1);
}
sub load_responsible {
my($pathname) = @_;
my($record);
open(RESPONSIBLE, $pathname) || die "Unable to open $pathname: $!";
while ($record = <RESPONSIBLE>) {
if ($record =~ /^#/) {
next;
}
push(@responsible_list, [split(/\|/, $record)]);
}
close(RESPONSIBLE) || die "Unable to close $pathname: $!";
return(1);
}
sub read_pr {
my($pr_filename) = @_;
my($multitext) = "Mail-Header";
my($field, $mail_header);
# Empty the hash.
%pr_data = ();
# Empty the list of duplicate fields.
$pr_data_dup_fields = "";
# Empty the list of badly labeled fields.
$pr_data_bad_fields = "";
unless (open(PR, $pr_filename)) {
warn "error opening $pr_filename: $!";
return(0);
}
LINELOOP: while (<PR>) {
chomp;
if ($multitext eq "Unformatted") {
# once we reach "Unformatted", rest of file goes there
$pr_data{$multitext} = append_multitext($pr_data{$multitext}, $_);
next LINELOOP;
}
# Handle ENUMERATED and TEXT fields.
foreach $field (@text_fields) {
if (/^>$field:($|\s+)/) {
$pr_data{$field} = $'; # part of string after match
$pr_data{$field} =~ s/\s+$//; # strip trailing whitespace
$multitext = "";
next LINELOOP;
}
}
# Handle MULTITEXT fields.
foreach $field (@multitext_fields) {
if (/^>$field:\s*$/) {
$_ = $'; # set to part of string after match part
if (defined($pr_data{$field})) {
if ($pr_data_dup_fields eq "") {
$pr_data_dup_fields = $field;
} else {
$pr_data_dup_fields = "$pr_data_dup_fields $field";
}
}
$pr_data{$field} = $_;
$multitext = $field;
next LINELOOP;
}
}
# Check for badly labeled fields.
foreach $field ((@text_fields, @multitext_fields)) {
if (/^>$field:/) {
if ($pr_data_bad_fields eq "") {
$pr_data_bad_fields = $field;
} else {
$pr_data_bad_fields = "$pr_data_bad_fields $field";
}
}
}
# Handle continued MULTITEXT field.
$pr_data{$multitext} = append_multitext($pr_data{$multitext}, $_);
}
close(PR) || warn "error closing $pr_filename: $!";
# Strip trailing newlines from MULTITEXT fields.
foreach $field (@multitext_fields) {
if (defined($pr_data{$field})) {
$pr_data{$field} =~ s/\s+$//;
}
}
return(1);
}
sub append_multitext {
my($original, $addition) = @_;
if (defined($original) && $original ne "") {
return "$original\n$addition";
} else {
return $addition;
}
}
sub check_pr {
my($pr) = @_;
my($error_list) = "";
if ($pr_data_dup_fields ne "") {
$error_list = append_error($error_list, "Multiple '$pr_data_dup_fields'");
}
if ($pr_data_bad_fields ne "") {
$error_list = append_error($error_list, "Bad field labels '$pr_data_bad_fields'");
}
if (!defined($pr_data{"Description"}) || $pr_data{"Description"} eq "") {
$error_list = append_error($error_list, "Description empty");
}
if (defined($pr_data{"Unformatted"}) && $pr_data{"Unformatted"} ne "") {
$error_list = append_error($error_list, "Unformatted text");
}
if (defined($pr_data{"Release"}) && length($pr_data{"Release"}) > 16) {
$error_list = append_error($error_list, "Release > 16 chars");
}
if (defined($pr_data{"Fix"}) && $pr_data{"Fix"} =~ /State-Changed-/) {
$error_list = append_error($error_list, "Audit in Fix field");
}
if (defined($pr_data{"Arrival-Date"})) {
if ($pr_data{"Arrival-Date"} eq "") {
$error_list = append_error($error_list, "Arrival-Date empty");
} elsif (unixdate2datetime($pr, $pr_data{"Arrival-Date"}) eq "") {
$error_list = append_error($error_list, "Arrival-Date format");
}
}
# More checks should go here.
if ($error_list ne "") {
if ($cleanup_with_edit_pr) {
my(@parts) = split("/", $pr);
my($pr_num) = $parts[1];
print CLEANUP "echo \"$error_list\"; edit-pr $pr_num\n";
} else {
print CLEANUP "echo \"$error_list\"; \${EDITOR} $pr\n";
}
}
}
sub append_error {
my($original, $addition) = @_;
if ($original ne "") {
return "$original, $addition";
} else {
return $addition;
}
}
sub translate_pr {
# This function performs GNATS -> Bugzilla translations that should
# happen before collect_stats().
if (!defined($pr_data{"Organization"})) {
$pr_data{"Originator"} = "";
}
if ($pr_data{"Organization"} =~ /$default_organization/) {
$pr_data{"Originator"} = "";
$pr_data{"Organization"} = "";
}
$pr_data{"Organization"} =~ s/^\s+//g; # strip leading whitespace
if (!defined($pr_data{"Release"}) ||
$pr_data{"Release"} eq "" ||
$pr_data{"Release"} =~ /^unknown-1.0$/
) {
$pr_data{"Release"} = "unknown";
}
if (defined($pr_data{"Responsible"})) {
$pr_data{"Responsible"} =~ /\w+/;
$pr_data{"Responsible"} = "$&$username_suffix";
}
my($rep_platform, $op_sys) = ("All", "All");
if (defined($pr_data{"Environment"})) {
if ($pr_data{"Environment"} =~ /[wW]in.*NT/) {
$rep_platform = "PC";
$op_sys = "Windows NT";
} elsif ($pr_data{"Environment"} =~ /[wW]in.*95/) {
$rep_platform = "PC";
$op_sys = "Windows 95";
} elsif ($pr_data{"Environment"} =~ /[wW]in.*98/) {
$rep_platform = "PC";
$op_sys = "Windows 98";
} elsif ($pr_data{"Environment"} =~ /OSF/) {
$rep_platform = "DEC";
$op_sys = "OSF/1";
} elsif ($pr_data{"Environment"} =~ /AIX/) {
$rep_platform = "RS/6000";
$op_sys = "AIX";
} elsif ($pr_data{"Environment"} =~ /IRIX/) {
$rep_platform = "SGI";
$op_sys = "IRIX";
} elsif ($pr_data{"Environment"} =~ /SunOS.*5\.\d/) {
$rep_platform = "Sun";
$op_sys = "Solaris";
} elsif ($pr_data{"Environment"} =~ /SunOS.*4\.\d/) {
$rep_platform = "Sun";
$op_sys = "SunOS";
}
}
$pr_data{"Environment"} = "$rep_platform:$op_sys";
}
sub collect_stats {
my($field, $value);
foreach $field (@statistics_fields) {
$value = $pr_data{$field};
if (!defined($value)) {
$value = "";
}
if (defined($pr_stats{$field}{$value})) {
$pr_stats{$field}{$value}++;
} else {
$pr_stats{$field}{$value} = 1;
}
}
}
sub report_stats {
my($field, $value, $count);
open(STATS, ">$stats_pathname") ||
die "Unable to open $stats_pathname: $!";
print STATS "Statistics of $gnats_db_dir collated by gnats2bz.pl.\n";
my($field_stats);
while (($field, $field_stats) = each(%pr_stats)) {
print STATS "\n$field:\n";
while (($value, $count) = each(%$field_stats)) {
print STATS " $value: $count\n";
}
}
close(STATS) || die "Unable to close $stats_pathname: $!";
}
sub get_userid {
my($responsible) = @_;
my($username, $userid);
if (!defined($responsible)) {
return(-1);
}
# Search for current username in the list.
$userid = $userid_base;
foreach $username (@username_list) {
if ($username eq $responsible) {
return($userid);
}
$userid++;
}
push(@username_list, $responsible);
return($userid);
}
sub update_versions {
if (!defined($pr_data{"Release"}) || !defined($pr_data{"Category"})) {
return;
}
my($curr_product) = $pr_data{"Category"};
my($curr_version) = $pr_data{"Release"};
if ($curr_version eq "") {
return;
}
if (!defined($versions_table{$curr_product})) {
$versions_table{$curr_product} = [ ];
}
my($version_list) = $versions_table{$curr_product};
my($version);
foreach $version (@$version_list) {
if ($version eq $curr_version) {
return;
}
}
push(@$version_list, $curr_version);
}
sub write_bugs {
my($bug_id) = $pr_data{"Number"};
my($userid) = get_userid($pr_data{"Responsible"});
# Mapping from Class,Severity to bug_severity
# At our site, the Severity,Priority fields have degenerated
# into a 9-level priority field.
my($bug_severity) = "normal";
if ($pr_data{"Class"} eq "change-request") {
$bug_severity = "enhancement";
} elsif (defined($pr_data{"Synopsis"})) {
if ($pr_data{"Synopsis"} =~ /crash|assert/i) {
$bug_severity = "critical";
} elsif ($pr_data{"Synopsis"} =~ /wrong|error/i) {
$bug_severity = "major";
}
}
$bug_severity = SqlQuote($bug_severity);
# Mapping from Severity,Priority to priority
# At our site, the Severity,Priority fields have degenerated
# into a 9-level priority field.
my($priority) = "Highest";
if (defined($pr_data{"Severity"}) && defined($pr_data{"Severity"})) {
if ($pr_data{"Severity"} eq "critical") {
if ($pr_data{"Priority"} eq "high") {
$priority = "Highest";
} else {
$priority = "High";
}
} elsif ($pr_data{"Severity"} eq "serious") {
if ($pr_data{"Priority"} eq "low") {
$priority = "Low";
} else {
$priority = "Normal";
}
} else {
if ($pr_data{"Priority"} eq "high") {
$priority = "Low";
} else {
$priority = "Lowest";
}
}
}
$priority = SqlQuote($priority);
# Map State,Class to bug_status,resolution
my($bug_status, $resolution);
if ($pr_data{"State"} eq "open" || $pr_data{"State"} eq "analyzed") {
$bug_status = "ASSIGNED";
$resolution = "";
} elsif ($pr_data{"State"} eq "feedback") {
$bug_status = "RESOLVED";
$resolution = "FIXED";
} elsif ($pr_data{"State"} eq "closed") {
$bug_status = "CLOSED";
if (defined($pr_data{"Class"}) && $pr_data{"Class"} =~ /^duplicate/) {
$resolution = "DUPLICATE";
} elsif (defined($pr_data{"Class"}) && $pr_data{"Class"} =~ /^mistaken/) {
$resolution = "INVALID";
} else {
$resolution = "FIXED";
}
} elsif ($pr_data{"State"} eq "suspended") {
$bug_status = "RESOLVED";
$resolution = "WONTFIX";
} else {
$bug_status = "NEW";
$resolution = "";
}
$bug_status = SqlQuote($bug_status);
$resolution = SqlQuote($resolution);
my($creation_ts) = "";
if (defined($pr_data{"Arrival-Date"}) && $pr_data{"Arrival-Date"} ne "") {
$creation_ts = unixdate2datetime($bug_id, $pr_data{"Arrival-Date"});
}
$creation_ts = SqlQuote($creation_ts);
my($delta_ts) = "";
if (defined($pr_data{"Audit-Trail"})) {
# note that (?:.|\n)+ is greedy, so this should match the
# last Changed-When
if ($pr_data{"Audit-Trail"} =~ /(?:.|\n)+-Changed-When: (.+)/) {
$delta_ts = unixdate2timestamp($bug_id, $1);
}
}
if ($delta_ts eq "") {
if (defined($pr_data{"Arrival-Date"}) && $pr_data{"Arrival-Date"} ne "") {
$delta_ts = unixdate2timestamp($bug_id, $pr_data{"Arrival-Date"});
}
}
$delta_ts = SqlQuote($delta_ts);
my($short_desc) = SqlQuote($pr_data{"Synopsis"});
my($rep_platform, $op_sys) = split(/\|/, $pr_data{"Environment"});
$rep_platform = SqlQuote($rep_platform);
$op_sys = SqlQuote($op_sys);
my($reporter) = get_userid($gnats_username);
if (
defined($pr_data{"Mail-Header"}) &&
$pr_data{"Mail-Header"} =~ /From ([\w.]+\@[\w.]+)/
) {
$reporter = get_userid($1);
}
my($version) = "";
if (defined($pr_data{"Release"})) {
$version = substr($pr_data{"Release"}, 0, 16);
}
$version = SqlQuote($version);
my($product) = "";
if (defined($pr_data{"Category"})) {
$product = $pr_data{"Category"};
}
$product = SqlQuote($product);
my($component) = SqlQuote($default_component);
my($target_milestone) = "0";
# $target_milestone = SqlQuote($target_milestone);
my($qa_contact) = "0";
# my($bug_file_loc) = "";
# $bug_file_loc = SqlQuote($bug_file_loc);
# my($status_whiteboard) = "";
# $status_whiteboard = SqlQuote($status_whiteboard);
print DATA "\ninsert into bugs (\n";
print DATA " bug_id, assigned_to, bug_severity, priority, bug_status, creation_ts, delta_ts,\n";
print DATA " short_desc,\n";
print DATA " rep_platform, op_sys, reporter, version,\n";
print DATA " product, component, resolution, target_milestone, qa_contact\n";
print DATA ") values (\n";
print DATA " $bug_id, $userid, $bug_severity, $priority, $bug_status, $creation_ts, $delta_ts,\n";
print DATA " $short_desc,\n";
print DATA " $rep_platform, $op_sys, $reporter, $version,\n";
print DATA " $product, $component, $resolution, $target_milestone, $qa_contact\n";
print DATA ");\n";
}
sub write_longdescs {
my($bug_id) = $pr_data{"Number"};
my($who) = get_userid($pr_data{"Responsible"});;
my($bug_when) = "";
if (defined($pr_data{"Arrival-Date"}) && $pr_data{"Arrival-Date"} ne "") {
$bug_when = unixdate2datetime($bug_id, $pr_data{"Arrival-Date"});
}
$bug_when = SqlQuote($bug_when);
my($thetext) = $pr_data{"Description"};
if (defined($pr_data{"How-To-Repeat"}) && $pr_data{"How-To-Repeat"} ne "") {
$thetext =
$thetext . "\n\nHow-To-Repeat:\n" . $pr_data{"How-To-Repeat"};
}
if (defined($pr_data{"Fix"}) && $pr_data{"Fix"} ne "") {
$thetext = $thetext . "\n\nFix:\n" . $pr_data{"Fix"};
}
if (defined($pr_data{"Originator"}) && $pr_data{"Originator"} ne "") {
$thetext = $thetext . "\n\nOriginator:\n" . $pr_data{"Originator"};
}
if (defined($pr_data{"Organization"}) && $pr_data{"Organization"} ne "") {
$thetext = $thetext . "\n\nOrganization:\n" . $pr_data{"Organization"};
}
if (defined($pr_data{"Audit-Trail"}) && $pr_data{"Audit-Trail"} ne "") {
$thetext = $thetext . "\n\nAudit-Trail:\n" . $pr_data{"Audit-Trail"};
}
if (defined($pr_data{"Unformatted"}) && $pr_data{"Unformatted"} ne "") {
$thetext = $thetext . "\n\nUnformatted:\n" . $pr_data{"Unformatted"};
}
$thetext = SqlQuote($thetext);
print DATA "\ninsert into longdescs (\n";
print DATA " bug_id, who, bug_when, thetext\n";
print DATA ") values (\n";
print DATA " $bug_id, $who, $bug_when, $thetext\n";
print DATA ");\n";
}
sub write_non_bugs_tables {
my($categories_record);
foreach $categories_record (@categories_list) {
my($component) = SqlQuote($default_component);
my($product) = SqlQuote(@$categories_record[0]);
my($description) = SqlQuote(@$categories_record[1]);
my($initialowner) = SqlQuote(@$categories_record[2] . $username_suffix);
print DATA "\ninsert into products (\n";
print DATA
" product, description, milestoneurl, isactive\n";
print DATA ") values (\n";
print DATA
" $product, $description, '', 1\n";
print DATA ");\n";
print DATA "\ninsert into components (\n";
print DATA
" value, program, initialowner, initialqacontact, description\n";
print DATA ") values (\n";
print DATA
" $component, $product, $initialowner, '', $description\n";
print DATA ");\n";
print DATA "\ninsert into milestones (\n";
print DATA
" value, product, sortkey\n";
print DATA ") values (\n";
print DATA
" 0, $product, 0\n";
print DATA ");\n";
}
my($username);
my($userid) = $userid_base;
my($password) = "password";
my($realname);
my($groupset) = 0;
foreach $username (@username_list) {
$realname = map_username_to_realname($username);
$username = SqlQuote($username);
$realname = SqlQuote($realname);
print DATA "\ninsert into profiles (\n";
print DATA
" userid, login_name, cryptpassword, realname, groupset\n";
print DATA ") values (\n";
print DATA
" $userid, $username, encrypt('$password'), $realname, $groupset\n";
print DATA ");\n";
$userid++;
}
my($product);
my($version_list);
while (($product, $version_list) = each(%versions_table)) {
$product = SqlQuote($product);
my($version);
foreach $version (@$version_list) {
$version = SqlQuote($version);
print DATA "\ninsert into versions (value, program) ";
print DATA "values ($version, $product);\n";
}
}
}
sub map_username_to_realname() {
my($username) = @_;
my($name, $realname);
# get the portion before the @
$name = $username;
$name =~ s/\@.*//;
my($responsible_record);
foreach $responsible_record (@responsible_list) {
if (@$responsible_record[0] eq $name) {
return(@$responsible_record[1]);
}
if (defined(@$responsible_record[2])) {
if (@$responsible_record[2] eq $username) {
return(@$responsible_record[1]);
}
}
}
return("");
}
sub detaint_string {
my ($str) = @_;
$str =~ m/^(.*)$/s;
$str = $1;
}
sub SqlQuote {
my ($str) = (@_);
$str =~ s/([\\\'])/\\$1/g;
$str =~ s/\0/\\0/g;
# If it's been SqlQuote()ed, then it's safe, so we tell -T that.
$str = detaint_string($str);
return "'$str'";
}
sub unixdate2datetime {
my($bugid, $unixdate) = @_;
my($year, $month, $day, $hour, $min, $sec);
if (!split_unixdate($bugid, $unixdate, \$year, \$month, \$day, \$hour, \$min, \$sec)) {
return("");
}
return("$year-$month-$day $hour:$min:$sec");
}
sub unixdate2timestamp {
my($bugid, $unixdate) = @_;
my($year, $month, $day, $hour, $min, $sec);
if (!split_unixdate($bugid, $unixdate, \$year, \$month, \$day, \$hour, \$min, \$sec)) {
return("");
}
return("$year$month$day$hour$min$sec");
}
sub split_unixdate {
# "Tue Jun 6 14:50:00 1995"
# "Mon Nov 20 17:03:11 [MST] 1995"
# "12/13/94"
# "jan 1, 1995"
my($bugid, $unixdate, $year, $month, $day, $hour, $min, $sec) = @_;
my(@parts);
$$hour = "00";
$$min = "00";
$$sec = "00";
@parts = split(/ +/, $unixdate);
if (@parts >= 5) {
# year
$$year = $parts[4];
if ($$year =~ /[A-Z]{3}/) {
# Must be timezone, try next field.
$$year = $parts[5];
}
if ($$year =~ /\D/) {
warn "$bugid: Error processing year part '$$year' of date '$unixdate'\n";
return(0);
}
if ($$year < 30) {
$$year = "20" . $$year;
} elsif ($$year < 100) {
$$year = "19" . $$year;
} elsif ($$year < 1970 || $$year > 2029) {
warn "$bugid: Error processing year part '$$year' of date '$unixdate'\n";
return(0);
}
# month
$$month = $parts[1];
if ($$month =~ /\D/) {
if (!month2number($month)) {
warn "$bugid: Error processing month part '$$month' of date '$unixdate'\n";
return(0);
}
} elsif ($$month < 1 || $$month > 12) {
warn "$bugid: Error processing month part '$$month' of date '$unixdate'\n";
return(0);
} elsif (length($$month) == 1) {
$$month = "0" . $$month;
}
# day
$$day = $parts[2];
if ($$day < 1 || $$day > 31) {
warn "$bugid: Error processing day part '$day' of date '$unixdate'\n";
return(0);
} elsif (length($$day) == 1) {
$$day = "0" . $$day;
}
@parts = split(/:/, $parts[3]);
$$hour = $parts[0];
$$min = $parts[1];
$$sec = $parts[2];
return(1);
} elsif (@parts == 3) {
# year
$$year = $parts[2];
if ($$year =~ /\D/) {
warn "$bugid: Error processing year part '$$year' of date '$unixdate'\n";
return(0);
}
if ($$year < 30) {
$$year = "20" . $$year;
} elsif ($$year < 100) {
$$year = "19" . $$year;
} elsif ($$year < 1970 || $$year > 2029) {
warn "$bugid: Error processing year part '$$year' of date '$unixdate'\n";
return(0);
}
# month
$$month = $parts[0];
if ($$month =~ /\D/) {
if (!month2number($month)) {
warn "$bugid: Error processing month part '$$month' of date '$unixdate'\n";
return(0);
}
} elsif ($$month < 1 || $$month > 12) {
warn "$bugid: Error processing month part '$$month' of date '$unixdate'\n";
return(0);
} elsif (length($$month) == 1) {
$$month = "0" . $$month;
}
# day
$$day = $parts[1];
$$day =~ s/,//;
if ($$day < 1 || $$day > 31) {
warn "$bugid: Error processing day part '$day' of date '$unixdate'\n";
return(0);
} elsif (length($$day) == 1) {
$$day = "0" . $$day;
}
return(1);
}
@parts = split(/:/, $unixdate);
if (@parts == 3 && length($unixdate) <= 8) {
$$year = "19" . $parts[2];
$$month = $parts[0];
if (length($$month) == 1) {
$$month = "0" . $$month;
}
$$day = $parts[1];
if (length($$day) == 1) {
$$day = "0" . $$day;
}
return(1);
}
warn "$bugid: Error processing date '$unixdate'\n";
return(0);
}
sub month2number {
my($month) = @_;
if ($$month =~ /jan/i) {
$$month = "01";
} elsif ($$month =~ /feb/i) {
$$month = "02";
} elsif ($$month =~ /mar/i) {
$$month = "03";
} elsif ($$month =~ /apr/i) {
$$month = "04";
} elsif ($$month =~ /may/i) {
$$month = "05";
} elsif ($$month =~ /jun/i) {
$$month = "06";
} elsif ($$month =~ /jul/i) {
$$month = "07";
} elsif ($$month =~ /aug/i) {
$$month = "08";
} elsif ($$month =~ /sep/i) {
$$month = "09";
} elsif ($$month =~ /oct/i) {
$$month = "10";
} elsif ($$month =~ /nov/i) {
$$month = "11";
} elsif ($$month =~ /dec/i) {
$$month = "12";
} else {
return(0);
}
return(1);
}
gnatsparse
==========
Author: Daniel Berlin <dan@dberlin.org>
gnatsparse is a simple Python program that imports a GNATS database
into a Bugzilla system. It is based on the gnats2bz.pl Perl script
but it's a rewrite at the same time. Its parser is based on gnatsweb,
which gives a 10 times speed improvement compared to the previous code.
Features
--------
* Chunks audit trail into separate comments, with the right From's, times, etc.
* Handles followup emails that are in the report, with the right From's, times,
etc.
* Properly handles duplicates, adding the standard bugzilla duplicate message.
* Extracts and handles gnatsweb attachments, as well as uuencoded attachments
appearing in either followup emails, the how-to-repeat field, etc. Replaces
them with a message to look at the attachments list, and adds the standard
"Created an attachment" message that bugzilla uses. Handling them includes
giving them the right name and mime-type. "attachments" means multiple
uuencoded things/gnatsweb attachments are handled properly.
* Handles reopened bug reports.
* Builds the cc list from the people who have commented on the report,
and the reporter.
Requirements
------------
It requires python 2.2+, it won't work with 1.5.2 (Linux distributions
ship with 2.2+ these days, so that shouldn't be an issue).
Documentation
-------------
Documentation can be found inside the scripts. The source code is self
documenting.
Issues for someone trying to use it to convert a gnats install
-----------------------------------
1. We have three custom fields bugzilla doesn't ship with,
gcchost, gcctarget, and gccbuild.
We removed two bugzilla fields, rep_platform and op_sys.
If you use the latter instead of the former, you'll need to
update the script to account for this.
2. Because gcc attachments consist of preprocessed source, all attachments
inserted into the attachment database are compressed with zlib.compress.
This requires associated bugzilla changes to decompress before sending to
the browser.
Unless you want to make those changes (it's roughly 3 lines), you'll
need to remove the zlib.compress call.
3. You will need to come up with your own release to version mapping and
install it.
4. Obviously, any extra gnats fields you have added will have to
be handled in some manner.
try:
# Using Psyco makes it about 25% faster, but there's a bug in psyco in
# handling of eval causing it to use unlimited memory with the magic
# file enabled.
# import psyco
# psyco.full()
# from psyco.classes import *
pass
except:
pass
import re
import base64
import cStringIO
import specialuu
import array
import email.Utils
import zlib
import magic
# Comment out if you don't want magic detection
magicf = magic.MagicFile()
# Open our output file
outfile = open("gnats2bz_data.sql", "w")
# List of GNATS fields
fieldnames = ("Number", "Category", "Synopsis", "Confidential", "Severity",
"Priority", "Responsible", "State", "Quarter", "Keywords",
"Date-Required", "Class", "Submitter-Id", "Arrival-Date",
"Closed-Date", "Last-Modified", "Originator", "Release",
"Organization", "Environment", "Description", "How-To-Repeat",
"Fix", "Release-Note", "Audit-Trail", "Unformatted")
# Dictionary telling us which GNATS fields are multiline
multilinefields = {"Organization":1, "Environment":1, "Description":1,
"How-To-Repeat":1, "Fix":1, "Release-Note":1,
"Audit-Trail":1, "Unformatted":1}
# Mapping of GCC release to version. Our version string is updated every
# so we need to funnel all release's with 3.4 in the string to be version
# 3.4 for bug tracking purposes
# The key is a regex to match, the value is the version it corresponds
# with
releasetovermap = {r"3\.4":"3.4", r"3\.3":"3.3", r"3\.2\.2":"3.2.2",
r"3\.2\.1":"3.2.1", r"3\.2":"3.2", r"3\.1\.2":"3.1.2",
r"3\.1\.1":"3.1.1", r"3\.1":"3.1", r"3\.0\.4":"3.0.4",
r"3\.0\.3":"3.0.3", r"3\.0\.2":"3.0.2", r"3\.0\.1":"3.0.1",
r"3\.0":"3.0", r"2\.95\.4":"2.95.4", r"2\.95\.3":"2.95.3",
r"2\.95\.2":"2.95.2", r"2\.95\.1":"2.95.1",
r"2\.95":"2.95", r"2\.97":"2.97",
r"2\.96.*[rR][eE][dD].*[hH][aA][tT]":"2.96 (redhat)",
r"2\.96":"2.96"}
# These map the field name to the field id bugzilla assigns. We need
# the id when doing bug activity.
fieldids = {"State":8, "Responsible":15}
# These are the keywords we use in gcc bug tracking. They are transformed
# into bugzilla keywords. The format here is <keyword>-><bugzilla keyword id>
keywordids = {"wrong-code":1, "ice-on-legal-code":2, "ice-on-illegal-code":3,
"rejects-legal":4, "accepts-illegal":5, "pessimizes-code":6}
# Map from GNATS states to Bugzilla states. Duplicates and reopened bugs
# are handled when parsing the audit trail, so no need for them here.
state_lookup = {"":"NEW", "open":"ASSIGNED", "analyzed":"ASSIGNED",
"feedback":"WAITING", "closed":"CLOSED",
"suspended":"SUSPENDED"}
# Table of versions that exist in the bugs, built up as we go along
versions_table = {}
# Delimiter gnatsweb uses for attachments
attachment_delimiter = "----gnatsweb-attachment----\n"
# Here starts the various regular expressions we use
# Matches an entire GNATS single line field
gnatfieldre = re.compile(r"""^([>\w\-]+)\s*:\s*(.*)\s*$""")
# Matches the name of a GNATS field
fieldnamere = re.compile(r"""^>(.*)$""")
# Matches the useless part of an envelope
uselessre = re.compile(r"""^(\S*?):\s*""", re.MULTILINE)
# Matches the filename in a content disposition
dispositionre = re.compile("(\\S+);\\s*filename=\"([^\"]+)\"")
# Matches the last changed date in the entire text of a bug
# If you have other editable fields that get audit trail entries, modify this
# The field names are explicitly listed in order to speed up matching
lastdatere = re.compile(r"""^(?:(?:State|Responsible|Priority|Severity)-Changed-When: )(.+?)$""", re.MULTILINE)
# Matches the From line of an email or the first line of an audit trail entry
# We use this re to find the begin lines of all the audit trail entries
# The field names are explicitly listed in order to speed up matching
fromtore=re.compile(r"""^(?:(?:State|Responsible|Priority|Severity)-Changed-From-To: |From: )""", re.MULTILINE)
# These re's match the various parts of an audit trail entry
changedfromtore=re.compile(r"""^(\w+?)-Changed-From-To: (.+?)$""", re.MULTILINE)
changedbyre=re.compile(r"""^\w+?-Changed-By: (.+?)$""", re.MULTILINE)
changedwhenre=re.compile(r"""^\w+?-Changed-When: (.+?)$""", re.MULTILINE)
changedwhyre=re.compile(r"""^\w+?-Changed-Why:\s*(.*?)$""", re.MULTILINE)
# This re matches audit trail text saying that the current bug is a duplicate of another
duplicatere=re.compile(r"""(?:")?Dup(?:licate)?(?:d)?(?:")? of .*?(\d+)""", re.IGNORECASE | re.MULTILINE)
# Get the text of a From: line
fromre=re.compile(r"""^From: (.*?)$""", re.MULTILINE)
# Get the text of a Date: Line
datere=re.compile(r"""^Date: (.*?)$""", re.MULTILINE)
# Map of the responsible file to email addresses
responsible_map = {}
# List of records in the responsible file
responsible_list = []
# List of records in the categories file
categories_list = []
# List of pr's in the index
pr_list = []
# Map usernames to user ids
usermapping = {}
# Start with this user id
userid_base = 2
# Name of gnats user
gnats_username = "gnats@gcc.gnu.org"
# Name of unassigned user
unassigned_username = "unassigned@gcc.gnu.org"
gnats_db_dir = "."
product = "gcc"
productdesc = "GNU Compiler Connection"
milestoneurl = "http://gcc/gnu.org"
defaultmilestone = "3.4"
def write_non_bug_tables():
""" Write out the non-bug related tables, such as products, profiles, etc."""
# Set all non-unconfirmed bugs's everconfirmed flag
print >>outfile, "update bugs set everconfirmed=1 where bug_status != 'UNCONFIRMED';"
# Set all bugs assigned to the unassigned user to NEW
print >>outfile, "update bugs set bug_status='NEW',assigned_to='NULL' where bug_status='ASSIGNED' AND assigned_to=3;"
# Insert the products
print >>outfile, "\ninsert into products ("
print >>outfile, " product, description, milestoneurl, isactive,"
print >>outfile, " defaultmilestone, votestoconfirm) values ("
print >>outfile, " '%s', '%s', '%s', 1, '%s', 1);" % (product,
productdesc,
milestoneurl,
defaultmilestone)
# Insert the components
for category in categories_list:
component = SqlQuote(category[0])
productstr = SqlQuote(product)
description = SqlQuote(category[1])
initialowner = SqlQuote("3")
print >>outfile, "\ninsert into components (";
print >>outfile, " value, program, initialowner, initialqacontact,"
print >>outfile, " description) values ("
print >>outfile, " %s, %s, %s, '', %s);" % (component, productstr,
initialowner, description)
# Insert the versions
for productstr, version_list in versions_table.items():
productstr = SqlQuote(productstr)
for version in version_list:
version = SqlQuote(version)
print >>outfile, "\ninsert into versions (value, program) "
print >>outfile, " values (%s, %s);" % (version, productstr)
# Insert the users
for username, userid in usermapping.items():
realname = map_username_to_realname(username)
username = SqlQuote(username)
realname = SqlQuote(realname)
print >>outfile, "\ninsert into profiles ("
print >>outfile, " userid, login_name, password, cryptpassword, realname, groupset"
print >>outfile, ") values ("
print >>outfile, "%s,%s,'password',encrypt('password'), %s, 0);" % (userid, username, realname)
print >>outfile, "update profiles set groupset=1 << 32 where login_name like '%\@gcc.gnu.org';"
def unixdate2datetime(unixdate):
""" Convert a unix date to a datetime value """
year, month, day, hour, min, sec, x, x, x, x = email.Utils.parsedate_tz(unixdate)
return "%d-%02d-%02d %02d:%02d:%02d" % (year,month,day,hour,min,sec)
def unixdate2timestamp(unixdate):
""" Convert a unix date to a timestamp value """
year, month, day, hour, min, sec, x, x, x, x = email.Utils.parsedate_tz(unixdate)
return "%d%02d%02d%02d%02d%02d" % (year,month,day,hour,min,sec)
def SqlQuote(str):
""" Perform SQL quoting on a string """
return "'%s'" % str.replace("'", """''""").replace("\\", "\\\\").replace("\0","\\0")
def convert_gccver_to_ver(gccver):
""" Given a gcc version, convert it to a Bugzilla version. """
for k in releasetovermap.keys():
if re.search(".*%s.*" % k, gccver) is not None:
return releasetovermap[k]
result = re.search(r""".*(\d\.\d) \d+ \(experimental\).*""", gccver)
if result is not None:
return result.group(1)
return "unknown"
def load_index(fname):
""" Load in the GNATS index file """
global pr_list
ifp = open(fname)
for record in ifp.xreadlines():
fields = record.split("|")
pr_list.append(fields[0])
ifp.close()
def load_categories(fname):
""" Load in the GNATS categories file """
global categories_list
cfp = open(fname)
for record in cfp.xreadlines():
if re.search("^#", record) is not None:
continue
categories_list.append(record.split(":"))
cfp.close()
def map_username_to_realname(username):
""" Given a username, find the real name """
name = username
name = re.sub("@.*", "", name)
for responsible_record in responsible_list:
if responsible_record[0] == name:
return responsible_record[1]
if len(responsible_record) > 2:
if responsible_record[2] == username:
return responsible_record[1]
return ""
def get_userid(responsible):
""" Given an email address, get the user id """
global responsible_map
global usermapping
global userid_base
if responsible is None:
return -1
responsible = responsible.lower()
responsible = re.sub("sources.redhat.com", "gcc.gnu.org", responsible)
if responsible_map.has_key(responsible):
responsible = responsible_map[responsible]
if usermapping.has_key(responsible):
return usermapping[responsible]
else:
usermapping[responsible] = userid_base
userid_base += 1
return usermapping[responsible]
def load_responsible(fname):
""" Load in the GNATS responsible file """
global responsible_map
global responsible_list
rfp = open(fname)
for record in rfp.xreadlines():
if re.search("^#", record) is not None:
continue
split_record = record.split(":")
responsible_map[split_record[0]] = split_record[2].rstrip()
responsible_list.append(record.split(":"))
rfp.close()
def split_csl(list):
""" Split a comma separated list """
newlist = re.split(r"""\s*,\s*""", list)
return newlist
def fix_email_addrs(addrs):
""" Perform various fixups and cleaning on an e-mail address """
addrs = split_csl(addrs)
trimmed_addrs = []
for addr in addrs:
addr = re.sub(r"""\(.*\)""","",addr)
addr = re.sub(r""".*<(.*)>.*""","\\1",addr)
addr = addr.rstrip()
addr = addr.lstrip()
trimmed_addrs.append(addr)
addrs = ", ".join(trimmed_addrs)
return addrs
class Bugzillabug(object):
""" Class representing a bugzilla bug """
def __init__(self, gbug):
""" Initialize a bugzilla bug from a GNATS bug. """
self.bug_id = gbug.bug_id
self.long_descs = []
self.bug_ccs = [get_userid("gcc-bugs@gcc.gnu.org")]
self.bug_activity = []
self.attachments = gbug.attachments
self.gnatsfields = gbug.fields
self.need_unformatted = gbug.has_unformatted_attach == 0
self.need_unformatted &= gbug.fields.has_key("Unformatted")
self.translate_pr()
self.update_versions()
if self.fields.has_key("Audit-Trail"):
self.parse_audit_trail()
self.write_bug()
def parse_fromto(type, string):
""" Parses the from and to parts of a changed-from-to line """
fromstr = ""
tostr = ""
# Some slightly messed up changed lines have unassigned-new,
# instead of unassigned->new. So we make the > optional.
result = re.search(r"""(.*)-(?:>?)(.*)""", string)
# Only know how to handle parsing of State and Responsible
# changed-from-to right now
if type == "State":
fromstr = state_lookup[result.group(1)]
tostr = state_lookup[result.group(2)]
elif type == "Responsible":
if result.group(1) != "":
fromstr = result.group(1)
if result.group(2) != "":
tostr = result.group(2)
if responsible_map.has_key(fromstr):
fromstr = responsible_map[fromstr]
if responsible_map.has_key(tostr):
tostr = responsible_map[tostr]
return (fromstr, tostr)
parse_fromto = staticmethod(parse_fromto)
def parse_audit_trail(self):
""" Parse a GNATS audit trail """
trail = self.fields["Audit-Trail"]
# Begin to split the audit trail into pieces
result = fromtore.finditer(trail)
starts = []
ends = []
pieces = []
# Make a list of the pieces
for x in result:
pieces.append (x)
# Find the start and end of each piece
if len(pieces) > 0:
for x in xrange(len(pieces)-1):
starts.append(pieces[x].start())
ends.append(pieces[x+1].start())
starts.append(pieces[-1].start())
ends.append(len(trail))
pieces = []
# Now make the list of actual text of the pieces
for x in xrange(len(starts)):
pieces.append(trail[starts[x]:ends[x]])
# And parse the actual pieces
for piece in pieces:
result = changedfromtore.search(piece)
# See what things we actually have inside this entry, and
# handle them appropriately
if result is not None:
type = result.group(1)
changedfromto = result.group(2)
# If the bug was reopened, mark it as such
if changedfromto.find("closed->analyzed") != -1:
if self.fields["bug_status"] == "'NEW'":
self.fields["bug_status"] = "'REOPENED'"
if type == "State" or type == "Responsible":
oldstate, newstate = self.parse_fromto (type, changedfromto)
result = changedbyre.search(piece)
if result is not None:
changedby = result.group(1)
result = changedwhenre.search(piece)
if result is not None:
changedwhen = result.group(1)
changedwhen = unixdate2datetime(changedwhen)
changedwhen = SqlQuote(changedwhen)
result = changedwhyre.search(piece)
changedwhy = piece[result.start(1):]
#changedwhy = changedwhy.lstrip()
changedwhy = changedwhy.rstrip()
changedby = get_userid(changedby)
# Put us on the cc list if we aren't there already
if changedby != self.fields["userid"] \
and changedby not in self.bug_ccs:
self.bug_ccs.append(changedby)
# If it's a duplicate, mark it as such
result = duplicatere.search(changedwhy)
if result is not None:
newtext = "*** This bug has been marked as a duplicate of %s ***" % result.group(1)
newtext = SqlQuote(newtext)
self.long_descs.append((self.bug_id, changedby,
changedwhen, newtext))
self.fields["bug_status"] = "'RESOLVED'"
self.fields["resolution"] = "'DUPLICATE'"
self.fields["userid"] = changedby
else:
newtext = "%s-Changed-From-To: %s\n%s-Changed-Why: %s\n" % (type, changedfromto, type, changedwhy)
newtext = SqlQuote(newtext)
self.long_descs.append((self.bug_id, changedby,
changedwhen, newtext))
if type == "State" or type == "Responsible":
newstate = SqlQuote("%s" % newstate)
oldstate = SqlQuote("%s" % oldstate)
fieldid = fieldids[type]
self.bug_activity.append((newstate, oldstate, fieldid, changedby, changedwhen))
else:
# It's an email
result = fromre.search(piece)
if result is None:
continue
fromstr = result.group(1)
fromstr = fix_email_addrs(fromstr)
fromstr = get_userid(fromstr)
result = datere.search(piece)
if result is None:
continue
datestr = result.group(1)
datestr = SqlQuote(unixdate2timestamp(datestr))
if fromstr != self.fields["userid"] \
and fromstr not in self.bug_ccs:
self.bug_ccs.append(fromstr)
self.long_descs.append((self.bug_id, fromstr, datestr,
SqlQuote(piece)))
def write_bug(self):
""" Output a bug to the data file """
fields = self.fields
print >>outfile, "\ninsert into bugs("
print >>outfile, " bug_id, assigned_to, bug_severity, priority, bug_status, creation_ts, delta_ts,"
print >>outfile, " short_desc,"
print >>outfile, " reporter, version,"
print >>outfile, " product, component, resolution, target_milestone, qa_contact,"
print >>outfile, " gccbuild, gcctarget, gcchost, keywords"
print >>outfile, " ) values ("
print >>outfile, "%s, %s, %s, %s, %s, %s, %s," % (self.bug_id, fields["userid"], fields["bug_severity"], fields["priority"], fields["bug_status"], fields["creation_ts"], fields["delta_ts"])
print >>outfile, "%s," % (fields["short_desc"])
print >>outfile, "%s, %s," % (fields["reporter"], fields["version"])
print >>outfile, "%s, %s, %s, %s, 0," %(fields["product"], fields["component"], fields["resolution"], fields["target_milestone"])
print >>outfile, "%s, %s, %s, %s" % (fields["gccbuild"], fields["gcctarget"], fields["gcchost"], fields["keywords"])
print >>outfile, ");"
if self.fields["keywords"] != 0:
print >>outfile, "\ninsert into keywords (bug_id, keywordid) values ("
print >>outfile, " %s, %s);" % (self.bug_id, fields["keywordid"])
for id, who, when, text in self.long_descs:
print >>outfile, "\ninsert into longdescs ("
print >>outfile, " bug_id, who, bug_when, thetext) values("
print >>outfile, " %s, %s, %s, %s);" % (id, who, when, text)
for name, data, who in self.attachments:
print >>outfile, "\ninsert into attachments ("
print >>outfile, " bug_id, filename, description, mimetype, ispatch, submitter_id) values ("
ftype = None
# It's *magic*!
if name.endswith(".ii") == 1:
ftype = "text/x-c++"
elif name.endswith(".i") == 1:
ftype = "text/x-c"
else:
ftype = magicf.detect(cStringIO.StringIO(data))
if ftype is None:
ftype = "application/octet-stream"
print >>outfile, "%s,%s,%s, %s,0, %s,%s);" %(self.bug_id, SqlQuote(name), SqlQuote(name), SqlQuote (ftype), who)
print >>outfile, "\ninsert into attach_data ("
print >>outfile, "\n(id, thedata) values (last_insert_id(),"
print >>outfile, "%s);" % (SqlQuote(zlib.compress(data)))
for newstate, oldstate, fieldid, changedby, changedwhen in self.bug_activity:
print >>outfile, "\ninsert into bugs_activity ("
print >>outfile, " bug_id, who, bug_when, fieldid, added, removed) values ("
print >>outfile, " %s, %s, %s, %s, %s, %s);" % (self.bug_id,
changedby,
changedwhen,
fieldid,
newstate,
oldstate)
for cc in self.bug_ccs:
print >>outfile, "\ninsert into cc(bug_id, who) values (%s, %s);" %(self.bug_id, cc)
def update_versions(self):
""" Update the versions table to account for the version on this bug """
global versions_table
if self.fields.has_key("Release") == 0 \
or self.fields.has_key("Category") == 0:
return
curr_product = "gcc"
curr_version = self.fields["Release"]
if curr_version == "":
return
curr_version = convert_gccver_to_ver (curr_version)
if versions_table.has_key(curr_product) == 0:
versions_table[curr_product] = []
for version in versions_table[curr_product]:
if version == curr_version:
return
versions_table[curr_product].append(curr_version)
def translate_pr(self):
""" Transform a GNATS PR into a Bugzilla bug """
self.fields = self.gnatsfields
if (self.fields.has_key("Organization") == 0) \
or self.fields["Organization"].find("GCC"):
self.fields["Originator"] = ""
self.fields["Organization"] = ""
self.fields["Organization"].lstrip()
if (self.fields.has_key("Release") == 0) \
or self.fields["Release"] == "" \
or self.fields["Release"].find("unknown-1.0") != -1:
self.fields["Release"]="unknown"
if self.fields.has_key("Responsible"):
result = re.search(r"""\w+""", self.fields["Responsible"])
self.fields["Responsible"] = "%s%s" % (result.group(0), "@gcc.gnu.org")
self.fields["gcchost"] = ""
self.fields["gcctarget"] = ""
self.fields["gccbuild"] = ""
if self.fields.has_key("Environment"):
result = re.search("^host: (.+?)$", self.fields["Environment"],
re.MULTILINE)
if result is not None:
self.fields["gcchost"] = result.group(1)
result = re.search("^target: (.+?)$", self.fields["Environment"],
re.MULTILINE)
if result is not None:
self.fields["gcctarget"] = result.group(1)
result = re.search("^build: (.+?)$", self.fields["Environment"],
re.MULTILINE)
if result is not None:
self.fields["gccbuild"] = result.group(1)
self.fields["userid"] = get_userid(self.fields["Responsible"])
self.fields["bug_severity"] = "normal"
if self.fields["Class"] == "change-request":
self.fields["bug_severity"] = "enhancement"
elif self.fields.has_key("Severity"):
if self.fields["Severity"] == "critical":
self.fields["bug_severity"] = "critical"
elif self.fields["Severity"] == "serious":
self.fields["bug_severity"] = "major"
elif self.fields.has_key("Synopsis"):
if re.search("crash|assert", self.fields["Synopsis"]):
self.fields["bug_severity"] = "critical"
elif re.search("wrong|error", self.fields["Synopsis"]):
self.fields["bug_severity"] = "major"
self.fields["bug_severity"] = SqlQuote(self.fields["bug_severity"])
self.fields["keywords"] = 0
if keywordids.has_key(self.fields["Class"]):
self.fields["keywords"] = self.fields["Class"]
self.fields["keywordid"] = keywordids[self.fields["Class"]]
self.fields["keywords"] = SqlQuote(self.fields["keywords"])
self.fields["priority"] = "P1"
if self.fields.has_key("Severity") and self.fields.has_key("Priority"):
severity = self.fields["Severity"]
priority = self.fields["Priority"]
if severity == "critical":
if priority == "high":
self.fields["priority"] = "Highest"
else:
self.fields["priority"] = "High"
elif severity == "serious":
if priority == "low":
self.fields["priority"] = "Low"
else:
self.fields["priority"] = "Normal"
else:
if priority == "high":
self.fields["priority"] = "Low"
else:
self.fields["priority"] = "Lowest"
self.fields["priority"] = SqlQuote(self.fields["priority"])
state = self.fields["State"]
if (state == "open" or state == "analyzed") and self.fields["userid"] != 3:
self.fields["bug_status"] = "ASSIGNED"
self.fields["resolution"] = ""
elif state == "feedback":
self.fields["bug_status"] = "WAITING"
self.fields["resolution"] = ""
elif state == "closed":
self.fields["bug_status"] = "CLOSED"
if self.fields.has_key("Class"):
theclass = self.fields["Class"]
if theclass.find("duplicate") != -1:
self.fields["resolution"]="DUPLICATE"
elif theclass.find("mistaken") != -1:
self.fields["resolution"]="INVALID"
else:
self.fields["resolution"]="FIXED"
else:
self.fields["resolution"]="FIXED"
elif state == "suspended":
self.fields["bug_status"] = "SUSPENDED"
self.fields["resolution"] = ""
elif state == "analyzed" and self.fields["userid"] == 3:
self.fields["bug_status"] = "NEW"
self.fields["resolution"] = ""
else:
self.fields["bug_status"] = "UNCONFIRMED"
self.fields["resolution"] = ""
self.fields["bug_status"] = SqlQuote(self.fields["bug_status"])
self.fields["resolution"] = SqlQuote(self.fields["resolution"])
self.fields["creation_ts"] = ""
if self.fields.has_key("Arrival-Date") and self.fields["Arrival-Date"] != "":
self.fields["creation_ts"] = unixdate2datetime(self.fields["Arrival-Date"])
self.fields["creation_ts"] = SqlQuote(self.fields["creation_ts"])
self.fields["delta_ts"] = ""
if self.fields.has_key("Audit-Trail"):
result = lastdatere.findall(self.fields["Audit-Trail"])
result.reverse()
if len(result) > 0:
self.fields["delta_ts"] = unixdate2timestamp(result[0])
if self.fields["delta_ts"] == "":
if self.fields.has_key("Arrival-Date") and self.fields["Arrival-Date"] != "":
self.fields["delta_ts"] = unixdate2timestamp(self.fields["Arrival-Date"])
self.fields["delta_ts"] = SqlQuote(self.fields["delta_ts"])
self.fields["short_desc"] = SqlQuote(self.fields["Synopsis"])
if self.fields.has_key("Reply-To") and self.fields["Reply-To"] != "":
self.fields["reporter"] = get_userid(self.fields["Reply-To"])
elif self.fields.has_key("Mail-Header"):
result = re.search(r"""From .*?([\w.]+@[\w.]+)""", self.fields["Mail-Header"])
if result:
self.fields["reporter"] = get_userid(result.group(1))
else:
self.fields["reporter"] = get_userid(gnats_username)
else:
self.fields["reporter"] = get_userid(gnats_username)
long_desc = self.fields["Description"]
long_desc2 = ""
for field in ["Release", "Environment", "How-To-Repeat"]:
if self.fields.has_key(field) and self.fields[field] != "":
long_desc += ("\n\n%s:\n" % field) + self.fields[field]
if self.fields.has_key("Fix") and self.fields["Fix"] != "":
long_desc2 = "Fix:\n" + self.fields["Fix"]
if self.need_unformatted == 1 and self.fields["Unformatted"] != "":
long_desc += "\n\nUnformatted:\n" + self.fields["Unformatted"]
if long_desc != "":
self.long_descs.append((self.bug_id, self.fields["reporter"],
self.fields["creation_ts"],
SqlQuote(long_desc)))
if long_desc2 != "":
self.long_descs.append((self.bug_id, self.fields["reporter"],
self.fields["creation_ts"],
SqlQuote(long_desc2)))
for field in ["gcchost", "gccbuild", "gcctarget"]:
self.fields[field] = SqlQuote(self.fields[field])
self.fields["version"] = ""
if self.fields["Release"] != "":
self.fields["version"] = convert_gccver_to_ver (self.fields["Release"])
self.fields["version"] = SqlQuote(self.fields["version"])
self.fields["product"] = SqlQuote("gcc")
self.fields["component"] = "invalid"
if self.fields.has_key("Category"):
self.fields["component"] = self.fields["Category"]
self.fields["component"] = SqlQuote(self.fields["component"])
self.fields["target_milestone"] = "---"
if self.fields["version"].find("3.4") != -1:
self.fields["target_milestone"] = "3.4"
self.fields["target_milestone"] = SqlQuote(self.fields["target_milestone"])
if self.fields["userid"] == 2:
self.fields["userid"] = "\'NULL\'"
class GNATSbug(object):
""" Represents a single GNATS PR """
def __init__(self, filename):
self.attachments = []
self.has_unformatted_attach = 0
fp = open (filename)
self.fields = self.parse_pr(fp.xreadlines())
self.bug_id = int(self.fields["Number"])
if self.fields.has_key("Unformatted"):
self.find_gnatsweb_attachments()
if self.fields.has_key("How-To-Repeat"):
self.find_regular_attachments("How-To-Repeat")
if self.fields.has_key("Fix"):
self.find_regular_attachments("Fix")
def get_attacher(fields):
if fields.has_key("Reply-To") and fields["Reply-To"] != "":
return get_userid(fields["Reply-To"])
else:
result = None
if fields.has_key("Mail-Header"):
result = re.search(r"""From .*?([\w.]+\@[\w.]+)""",
fields["Mail-Header"])
if result is not None:
reporter = get_userid(result.group(1))
else:
reporter = get_userid(gnats_username)
get_attacher = staticmethod(get_attacher)
def find_regular_attachments(self, which):
fields = self.fields
while re.search("^begin [0-7]{3}", fields[which],
re.DOTALL | re.MULTILINE):
outfp = cStringIO.StringIO()
infp = cStringIO.StringIO(fields[which])
filename, start, end = specialuu.decode(infp, outfp, quiet=0)
fields[which]=fields[which].replace(fields[which][start:end],
"See attachments for %s\n" % filename)
self.attachments.append((filename, outfp.getvalue(),
self.get_attacher(fields)))
def decode_gnatsweb_attachment(self, attachment):
result = re.split(r"""\n\n""", attachment, 1)
if len(result) == 1:
return -1
envelope, body = result
envelope = uselessre.split(envelope)
envelope.pop(0)
# Turn the list of key, value into a dict of key => value
attachinfo = dict([(envelope[i], envelope[i+1]) for i in xrange(0,len(envelope),2)])
for x in attachinfo.keys():
attachinfo[x] = attachinfo[x].rstrip()
if (attachinfo.has_key("Content-Type") == 0) or \
(attachinfo.has_key("Content-Disposition") == 0):
raise ValueError, "Unable to parse file attachment"
result = dispositionre.search(attachinfo["Content-Disposition"])
filename = result.group(2)
filename = re.sub(".*/","", filename)
filename = re.sub(".*\\\\","", filename)
attachinfo["filename"]=filename
result = re.search("""(\S+);.*""", attachinfo["Content-Type"])
if result is not None:
attachinfo["Content-Type"] = result.group(1)
if attachinfo.has_key("Content-Transfer-Encoding"):
if attachinfo["Content-Transfer-Encoding"] == "base64":
attachinfo["data"] = base64.decodestring(body)
else:
attachinfo["data"]=body
return (attachinfo["filename"], attachinfo["data"],
self.get_attacher(self.fields))
def find_gnatsweb_attachments(self):
fields = self.fields
attachments = re.split(attachment_delimiter, fields["Unformatted"])
fields["Unformatted"] = attachments.pop(0)
for attachment in attachments:
result = self.decode_gnatsweb_attachment (attachment)
if result != -1:
self.attachments.append(result)
self.has_unformatted_attach = 1
def parse_pr(lines):
#fields = {"envelope":[]}
fields = {"envelope":array.array("c")}
hdrmulti = "envelope"
for line in lines:
line = line.rstrip('\n')
line += '\n'
result = gnatfieldre.search(line)
if result is None:
if hdrmulti != "":
if fields.has_key(hdrmulti):
#fields[hdrmulti].append(line)
fields[hdrmulti].fromstring(line)
else:
#fields[hdrmulti] = [line]
fields[hdrmulti] = array.array("c", line)
continue
hdr, arg = result.groups()
ghdr = "*not valid*"
result = fieldnamere.search(hdr)
if result != None:
ghdr = result.groups()[0]
if ghdr in fieldnames:
if multilinefields.has_key(ghdr):
hdrmulti = ghdr
#fields[ghdr] = [""]
fields[ghdr] = array.array("c")
else:
hdrmulti = ""
#fields[ghdr] = [arg]
fields[ghdr] = array.array("c", arg)
elif hdrmulti != "":
#fields[hdrmulti].append(line)
fields[hdrmulti].fromstring(line)
if hdrmulti == "envelope" and \
(hdr == "Reply-To" or hdr == "From" \
or hdr == "X-GNATS-Notify"):
arg = fix_email_addrs(arg)
#fields[hdr] = [arg]
fields[hdr] = array.array("c", arg)
if fields.has_key("Reply-To") and len(fields["Reply-To"]) > 0:
fields["Reply-To"] = fields["Reply-To"]
else:
fields["Reply-To"] = fields["From"]
if fields.has_key("From"):
del fields["From"]
if fields.has_key("X-GNATS-Notify") == 0:
fields["X-GNATS-Notify"] = array.array("c")
#fields["X-GNATS-Notify"] = ""
for x in fields.keys():
fields[x] = fields[x].tostring()
#fields[x] = "".join(fields[x])
for x in fields.keys():
if multilinefields.has_key(x):
fields[x] = fields[x].rstrip()
return fields
parse_pr = staticmethod(parse_pr)
load_index("%s/gnats-adm/index" % gnats_db_dir)
load_categories("%s/gnats-adm/categories" % gnats_db_dir)
load_responsible("%s/gnats-adm/responsible" % gnats_db_dir)
get_userid(gnats_username)
get_userid(unassigned_username)
for x in pr_list:
print "Processing %s..." % x
a = GNATSbug ("%s/%s" % (gnats_db_dir, x))
b = Bugzillabug(a)
write_non_bug_tables()
outfile.close()
# Found on a russian zope mailing list, and modified to fix bugs in parsing
# the magic file and string making
# -- Daniel Berlin <dberlin@dberlin.org>
import sys, struct, time, re, exceptions, pprint, stat, os, pwd, grp
_mew = 0
# _magic='/tmp/magic'
# _magic='/usr/share/magic.mime'
_magic='/usr/share/magic.mime'
mime = 1
_ldate_adjust = lambda x: time.mktime( time.gmtime(x) )
BUFFER_SIZE = 1024 * 128 # 128K should be enough...
class MagicError(exceptions.Exception): pass
def _handle(fmt='@x',adj=None): return fmt, struct.calcsize(fmt), adj
KnownTypes = {
# 'byte':_handle('@b'),
'byte':_handle('@B'),
'ubyte':_handle('@B'),
'string':('s',0,None),
'pstring':_handle('p'),
# 'short':_handle('@h'),
# 'beshort':_handle('>h'),
# 'leshort':_handle('<h'),
'short':_handle('@H'),
'beshort':_handle('>H'),
'leshort':_handle('<H'),
'ushort':_handle('@H'),
'ubeshort':_handle('>H'),
'uleshort':_handle('<H'),
'long':_handle('@l'),
'belong':_handle('>l'),
'lelong':_handle('<l'),
'ulong':_handle('@L'),
'ubelong':_handle('>L'),
'ulelong':_handle('<L'),
'date':_handle('=l'),
'bedate':_handle('>l'),
'ledate':_handle('<l'),
'ldate':_handle('=l',_ldate_adjust),
'beldate':_handle('>l',_ldate_adjust),
'leldate':_handle('<l',_ldate_adjust),
}
_mew_cnt = 0
def mew(x):
global _mew_cnt
if _mew :
if x=='.' :
_mew_cnt += 1
if _mew_cnt % 64 == 0 : sys.stderr.write( '\n' )
sys.stderr.write( '.' )
else:
sys.stderr.write( '\b'+x )
def has_format(s):
n = 0
l = None
for c in s :
if c == '%' :
if l == '%' : n -= 1
else : n += 1
l = c
return n
def read_asciiz(file,size=None,pos=None):
s = []
if pos :
mew('s')
file.seek( pos, 0 )
mew('z')
if size is not None :
s = [file.read( size ).split('\0')[0]]
else:
while 1 :
c = file.read(1)
if (not c) or (ord(c)==0) or (c=='\n') : break
s.append (c)
mew('Z')
return ''.join(s)
def a2i(v,base=0):
if v[-1:] in 'lL' : v = v[:-1]
return int( v, base )
_cmap = {
'\\' : '\\',
'0' : '\0',
}
for c in range(ord('a'),ord('z')+1) :
try : e = eval('"\\%c"' % chr(c))
except ValueError : pass
else : _cmap[chr(c)] = e
else:
del c
del e
def make_string(s):
return eval( '"'+s.replace('"','\\"')+'"')
class MagicTestError(MagicError): pass
class MagicTest:
def __init__(self,offset,mtype,test,message,line=None,level=None):
self.line, self.level = line, level
self.mtype = mtype
self.mtest = test
self.subtests = []
self.mask = None
self.smod = None
self.nmod = None
self.offset, self.type, self.test, self.message = \
offset,mtype,test,message
if self.mtype == 'true' : return # XXX hack to enable level skips
if test[-1:]=='\\' and test[-2:]!='\\\\' :
self.test += 'n' # looks like someone wanted EOL to match?
if mtype[:6]=='string' :
if '/' in mtype : # for strings
self.type, self.smod = \
mtype[:mtype.find('/')], mtype[mtype.find('/')+1:]
else:
for nm in '&+-' :
if nm in mtype : # for integer-based
self.nmod, self.type, self.mask = (
nm,
mtype[:mtype.find(nm)],
# convert mask to int, autodetect base
int( mtype[mtype.find(nm)+1:], 0 )
)
break
self.struct, self.size, self.cast = KnownTypes[ self.type ]
def __str__(self):
return '%s %s %s %s' % (
self.offset, self.mtype, self.mtest, self.message
)
def __repr__(self):
return 'MagicTest(%s,%s,%s,%s,line=%s,level=%s,subtests=\n%s%s)' % (
`self.offset`, `self.mtype`, `self.mtest`, `self.message`,
`self.line`, `self.level`,
'\t'*self.level, pprint.pformat(self.subtests)
)
def run(self,file):
result = ''
do_close = 0
try:
if type(file) == type('x') :
file = open( file, 'r', BUFFER_SIZE )
do_close = 1
# else:
# saved_pos = file.tell()
if self.mtype != 'true' :
data = self.read(file)
last = file.tell()
else:
data = last = None
if self.check( data ) :
result = self.message+' '
if has_format( result ) : result %= data
for test in self.subtests :
m = test.run(file)
if m is not None : result += m
return make_string( result )
finally:
if do_close :
file.close()
# else:
# file.seek( saved_pos, 0 )
def get_mod_and_value(self):
if self.type[-6:] == 'string' :
# "something like\tthis\n"
if self.test[0] in '=<>' :
mod, value = self.test[0], make_string( self.test[1:] )
else:
mod, value = '=', make_string( self.test )
else:
if self.test[0] in '=<>&^' :
mod, value = self.test[0], a2i(self.test[1:])
elif self.test[0] == 'x':
mod = self.test[0]
value = 0
else:
mod, value = '=', a2i(self.test)
return mod, value
def read(self,file):
mew( 's' )
file.seek( self.offset(file), 0 ) # SEEK_SET
mew( 'r' )
try:
data = rdata = None
# XXX self.size might be 0 here...
if self.size == 0 :
# this is an ASCIIZ string...
size = None
if self.test != '>\\0' : # magic's hack for string read...
value = self.get_mod_and_value()[1]
size = (value=='\0') and None or len(value)
rdata = data = read_asciiz( file, size=size )
else:
rdata = file.read( self.size )
if not rdata or (len(rdata)!=self.size) : return None
data = struct.unpack( self.struct, rdata )[0] # XXX hack??
except:
print >>sys.stderr, self
print >>sys.stderr, '@%s struct=%s size=%d rdata=%s' % (
self.offset, `self.struct`, self.size,`rdata`)
raise
mew( 'R' )
if self.cast : data = self.cast( data )
if self.mask :
try:
if self.nmod == '&' : data &= self.mask
elif self.nmod == '+' : data += self.mask
elif self.nmod == '-' : data -= self.mask
else: raise MagicTestError(self.nmod)
except:
print >>sys.stderr,'data=%s nmod=%s mask=%s' % (
`data`, `self.nmod`, `self.mask`
)
raise
return data
def check(self,data):
mew('.')
if self.mtype == 'true' :
return '' # not None !
mod, value = self.get_mod_and_value()
if self.type[-6:] == 'string' :
# "something like\tthis\n"
if self.smod :
xdata = data
if 'b' in self.smod : # all blanks are optional
xdata = ''.join( data.split() )
value = ''.join( value.split() )
if 'c' in self.smod : # all blanks are optional
xdata = xdata.upper()
value = value.upper()
# if 'B' in self.smod : # compact blanks
### XXX sorry, i don't understand this :-(
# data = ' '.join( data.split() )
# if ' ' not in data : return None
else:
xdata = data
try:
if mod == '=' : result = data == value
elif mod == '<' : result = data < value
elif mod == '>' : result = data > value
elif mod == '&' : result = data & value
elif mod == '^' : result = (data & (~value)) == 0
elif mod == 'x' : result = 1
else : raise MagicTestError(self.test)
if result :
zdata, zval = `data`, `value`
if self.mtype[-6:]!='string' :
try: zdata, zval = hex(data), hex(value)
except: zdata, zval = `data`, `value`
if 0 : print >>sys.stderr, '%s @%s %s:%s %s %s => %s (%s)' % (
'>'*self.level, self.offset,
zdata, self.mtype, `mod`, zval, `result`,
self.message
)
return result
except:
print >>sys.stderr,'mtype=%s data=%s mod=%s value=%s' % (
`self.mtype`, `data`, `mod`, `value`
)
raise
def add(self,mt):
if not isinstance(mt,MagicTest) :
raise MagicTestError((mt,'incorrect subtest type %s'%(type(mt),)))
if mt.level == self.level+1 :
self.subtests.append( mt )
elif self.subtests :
self.subtests[-1].add( mt )
elif mt.level > self.level+1 :
# it's possible to get level 3 just after level 1 !!! :-(
level = self.level + 1
while level < mt.level :
xmt = MagicTest(None,'true','x','',line=self.line,level=level)
self.add( xmt )
level += 1
else:
self.add( mt ) # retry...
else:
raise MagicTestError((mt,'incorrect subtest level %s'%(`mt.level`,)))
def last_test(self):
return self.subtests[-1]
#end class MagicTest
class OffsetError(MagicError): pass
class Offset:
pos_format = {'b':'<B','B':'>B','s':'<H','S':'>H','l':'<I','L':'>I',}
pattern0 = re.compile(r''' # mere offset
^
&? # possible ampersand
( 0 # just zero
| [1-9]{1,1}[0-9]* # decimal
| 0[0-7]+ # octal
| 0x[0-9a-f]+ # hex
)
$
''', re.X|re.I
)
pattern1 = re.compile(r''' # indirect offset
^\(
(?P<base>&?0 # just zero
|&?[1-9]{1,1}[0-9]* # decimal
|&?0[0-7]* # octal
|&?0x[0-9A-F]+ # hex
)
(?P<type>
\. # this dot might be alone
[BSL]? # one of this chars in either case
)?
(?P<sign>
[-+]{0,1}
)?
(?P<off>0 # just zero
|[1-9]{1,1}[0-9]* # decimal
|0[0-7]* # octal
|0x[0-9a-f]+ # hex
)?
\)$''', re.X|re.I
)
def __init__(self,s):
self.source = s
self.value = None
self.relative = 0
self.base = self.type = self.sign = self.offs = None
m = Offset.pattern0.match( s )
if m : # just a number
if s[0] == '&' :
self.relative, self.value = 1, int( s[1:], 0 )
else:
self.value = int( s, 0 )
return
m = Offset.pattern1.match( s )
if m : # real indirect offset
try:
self.base = m.group('base')
if self.base[0] == '&' :
self.relative, self.base = 1, int( self.base[1:], 0 )
else:
self.base = int( self.base, 0 )
if m.group('type') : self.type = m.group('type')[1:]
self.sign = m.group('sign')
if m.group('off') : self.offs = int( m.group('off'), 0 )
if self.sign == '-' : self.offs = 0 - self.offs
except:
print >>sys.stderr, '$$', m.groupdict()
raise
return
raise OffsetError(`s`)
def __call__(self,file=None):
if self.value is not None : return self.value
pos = file.tell()
try:
if not self.relative : file.seek( self.offset, 0 )
frmt = Offset.pos_format.get( self.type, 'I' )
size = struct.calcsize( frmt )
data = struct.unpack( frmt, file.read( size ) )
if self.offs : data += self.offs
return data
finally:
file.seek( pos, 0 )
def __str__(self): return self.source
def __repr__(self): return 'Offset(%s)' % `self.source`
#end class Offset
class MagicFileError(MagicError): pass
class MagicFile:
def __init__(self,filename=_magic):
self.file = None
self.tests = []
self.total_tests = 0
self.load( filename )
self.ack_tests = None
self.nak_tests = None
def __del__(self):
self.close()
def load(self,filename=None):
self.open( filename )
self.parse()
self.close()
def open(self,filename=None):
self.close()
if filename is not None :
self.filename = filename
self.file = open( self.filename, 'r', BUFFER_SIZE )
def close(self):
if self.file :
self.file.close()
self.file = None
def parse(self):
line_no = 0
for line in self.file.xreadlines() :
line_no += 1
if not line or line[0]=='#' : continue
line = line.lstrip().rstrip('\r\n')
if not line or line[0]=='#' : continue
try:
x = self.parse_line( line )
if x is None :
print >>sys.stderr, '#[%04d]#'%line_no, line
continue
except:
print >>sys.stderr, '###[%04d]###'%line_no, line
raise
self.total_tests += 1
level, offset, mtype, test, message = x
new_test = MagicTest(offset,mtype,test,message,
line=line_no,level=level)
try:
if level == 0 :
self.tests.append( new_test )
else:
self.tests[-1].add( new_test )
except:
if 1 :
print >>sys.stderr, 'total tests=%s' % (
`self.total_tests`,
)
print >>sys.stderr, 'level=%s' % (
`level`,
)
print >>sys.stderr, 'tests=%s' % (
pprint.pformat(self.tests),
)
raise
else:
while self.tests[-1].level > 0 :
self.tests.pop()
def parse_line(self,line):
# print >>sys.stderr, 'line=[%s]' % line
if (not line) or line[0]=='#' : return None
level = 0
offset = mtype = test = message = ''
mask = None
# get optional level (count leading '>')
while line and line[0]=='>' :
line, level = line[1:], level+1
# get offset
while line and not line[0].isspace() :
offset, line = offset+line[0], line[1:]
try:
offset = Offset(offset)
except:
print >>sys.stderr, 'line=[%s]' % line
raise
# skip spaces
line = line.lstrip()
# get type
c = None
while line :
last_c, c, line = c, line[0], line[1:]
if last_c!='\\' and c.isspace() :
break # unescaped space - end of field
else:
mtype += c
if last_c == '\\' :
c = None # don't fuck my brain with sequential backslashes
# skip spaces
line = line.lstrip()
# get test
c = None
while line :
last_c, c, line = c, line[0], line[1:]
if last_c!='\\' and c.isspace() :
break # unescaped space - end of field
else:
test += c
if last_c == '\\' :
c = None # don't fuck my brain with sequential backslashes
# skip spaces
line = line.lstrip()
# get message
message = line
if mime and line.find("\t") != -1:
message=line[0:line.find("\t")]
#
# print '>>', level, offset, mtype, test, message
return level, offset, mtype, test, message
def detect(self,file):
self.ack_tests = 0
self.nak_tests = 0
answers = []
for test in self.tests :
message = test.run( file )
if message :
self.ack_tests += 1
answers.append( message )
else:
self.nak_tests += 1
if answers :
return '; '.join( answers )
#end class MagicFile
def username(uid):
try:
return pwd.getpwuid( uid )[0]
except:
return '#%s'%uid
def groupname(gid):
try:
return grp.getgrgid( gid )[0]
except:
return '#%s'%gid
def get_file_type(fname,follow):
t = None
if not follow :
try:
st = os.lstat( fname ) # stat that entry, don't follow links!
except os.error, why :
pass
else:
if stat.S_ISLNK(st[stat.ST_MODE]) :
t = 'symbolic link'
try:
lnk = os.readlink( fname )
except:
t += ' (unreadable)'
else:
t += ' to '+lnk
if t is None :
try:
st = os.stat( fname )
except os.error, why :
return "can't stat `%s' (%s)." % (why.filename,why.strerror)
dmaj, dmin = (st.st_rdev>>8)&0x0FF, st.st_rdev&0x0FF
if 0 : pass
elif stat.S_ISSOCK(st.st_mode) : t = 'socket'
elif stat.S_ISLNK (st.st_mode) : t = follow and 'symbolic link' or t
elif stat.S_ISREG (st.st_mode) : t = 'file'
elif stat.S_ISBLK (st.st_mode) : t = 'block special (%d/%d)'%(dmaj,dmin)
elif stat.S_ISDIR (st.st_mode) : t = 'directory'
elif stat.S_ISCHR (st.st_mode) : t = 'character special (%d/%d)'%(dmaj,dmin)
elif stat.S_ISFIFO(st.st_mode) : t = 'pipe'
else: t = '<unknown>'
if st.st_mode & stat.S_ISUID :
t = 'setuid(%d=%s) %s'%(st.st_uid,username(st.st_uid),t)
if st.st_mode & stat.S_ISGID :
t = 'setgid(%d=%s) %s'%(st.st_gid,groupname(st.st_gid),t)
if st.st_mode & stat.S_ISVTX :
t = 'sticky '+t
return t
HELP = '''%s [options] [files...]
Options:
-?, --help -- this help
-m, --magic=<file> -- use this magic <file> instead of %s
-f, --files=<namefile> -- read filenames for <namefile>
* -C, --compile -- write "compiled" magic file
-b, --brief -- don't prepend filenames to output lines
+ -c, --check -- check the magic file
-i, --mime -- output MIME types
* -k, --keep-going -- don't stop st the first match
-n, --flush -- flush stdout after each line
-v, --verson -- print version and exit
* -z, --compressed -- try to look inside compressed files
-L, --follow -- follow symlinks
-s, --special -- don't skip special files
* -- not implemented so far ;-)
+ -- implemented, but in another way...
'''
def main():
import getopt
global _magic
try:
brief = 0
flush = 0
follow= 0
mime = 0
check = 0
special=0
try:
opts, args = getopt.getopt(
sys.argv[1:],
'?m:f:CbciknvzLs',
( 'help',
'magic=',
'names=',
'compile',
'brief',
'check',
'mime',
'keep-going',
'flush',
'version',
'compressed',
'follow',
'special',
)
)
except getopt.error, why:
print >>sys.stderr, sys.argv[0], why
return 1
else:
files = None
for o,v in opts :
if o in ('-?','--help'):
print HELP % (
sys.argv[0],
_magic,
)
return 0
elif o in ('-f','--files='):
files = v
elif o in ('-m','--magic='):
_magic = v[:]
elif o in ('-C','--compile'):
pass
elif o in ('-b','--brief'):
brief = 1
elif o in ('-c','--check'):
check = 1
elif o in ('-i','--mime'):
mime = 1
if os.path.exists( _magic+'.mime' ) :
_magic += '.mime'
print >>sys.stderr,sys.argv[0]+':',\
"Using regular magic file `%s'" % _magic
elif o in ('-k','--keep-going'):
pass
elif o in ('-n','--flush'):
flush = 1
elif o in ('-v','--version'):
print 'VERSION'
return 0
elif o in ('-z','--compressed'):
pass
elif o in ('-L','--follow'):
follow = 1
elif o in ('-s','--special'):
special = 1
else:
if files :
files = map(lambda x: x.strip(), v.split(','))
if '-' in files and '-' in args :
error( 1, 'cannot use STDIN simultaneously for file list and data' )
for file in files :
for name in (
(file=='-')
and sys.stdin
or open(file,'r',BUFFER_SIZE)
).xreadlines():
name = name.strip()
if name not in args :
args.append( name )
try:
if check : print >>sys.stderr, 'Loading magic database...'
t0 = time.time()
m = MagicFile(_magic)
t1 = time.time()
if check :
print >>sys.stderr, \
m.total_tests, 'tests loaded', \
'for', '%.2f' % (t1-t0), 'seconds'
print >>sys.stderr, len(m.tests), 'tests at top level'
return 0 # XXX "shortened" form ;-)
mlen = max( map(len, args) )+1
for arg in args :
if not brief : print (arg + ':').ljust(mlen),
ftype = get_file_type( arg, follow )
if (special and ftype.find('special')>=0) \
or ftype[-4:] == 'file' :
t0 = time.time()
try:
t = m.detect( arg )
except (IOError,os.error), why:
t = "can't read `%s' (%s)" % (why.filename,why.strerror)
if ftype[-4:] == 'file' : t = ftype[:-4] + t
t1 = time.time()
print t and t or 'data'
if 0 : print \
'#\t%d tests ok, %d tests failed for %.2f seconds'%\
(m.ack_tests, m.nak_tests, t1-t0)
else:
print mime and 'application/x-not-regular-file' or ftype
if flush : sys.stdout.flush()
# print >>sys.stderr, 'DONE'
except:
if check : return 1
raise
else:
return 0
finally:
pass
if __name__ == '__main__' :
sys.exit( main() )
# vim:ai
# EOF #
#! /usr/bin/env python2.2
# Copyright 1994 by Lance Ellinghouse
# Cathedral City, California Republic, United States of America.
# All Rights Reserved
# Permission to use, copy, modify, and distribute this software and its
# documentation for any purpose and without fee is hereby granted,
# provided that the above copyright notice appear in all copies and that
# both that copyright notice and this permission notice appear in
# supporting documentation, and that the name of Lance Ellinghouse
# not be used in advertising or publicity pertaining to distribution
# of the software without specific, written prior permission.
# LANCE ELLINGHOUSE DISCLAIMS ALL WARRANTIES WITH REGARD TO
# THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
# FITNESS, IN NO EVENT SHALL LANCE ELLINGHOUSE CENTRUM BE LIABLE
# FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
# Modified by Jack Jansen, CWI, July 1995:
# - Use binascii module to do the actual line-by-line conversion
# between ascii and binary. This results in a 1000-fold speedup. The C
# version is still 5 times faster, though.
# - Arguments more compliant with python standard
"""Implementation of the UUencode and UUdecode functions.
encode(in_file, out_file [,name, mode])
decode(in_file [, out_file, mode])
"""
import binascii
import os
import sys
from types import StringType
__all__ = ["Error", "decode"]
class Error(Exception):
pass
def decode(in_file, out_file=None, mode=None, quiet=0):
"""Decode uuencoded file"""
#
# Open the input file, if needed.
#
if in_file == '-':
in_file = sys.stdin
elif isinstance(in_file, StringType):
in_file = open(in_file)
#
# Read until a begin is encountered or we've exhausted the file
#
while 1:
hdr = in_file.readline()
if not hdr:
raise Error, 'No valid begin line found in input file'
if hdr[:5] != 'begin':
continue
hdrfields = hdr.split(" ", 2)
if len(hdrfields) == 3 and hdrfields[0] == 'begin':
try:
int(hdrfields[1], 8)
start_pos = in_file.tell() - len (hdr)
break
except ValueError:
pass
if out_file is None:
out_file = hdrfields[2].rstrip()
if os.path.exists(out_file):
raise Error, 'Cannot overwrite existing file: %s' % out_file
if mode is None:
mode = int(hdrfields[1], 8)
#
# Open the output file
#
if out_file == '-':
out_file = sys.stdout
elif isinstance(out_file, StringType):
fp = open(out_file, 'wb')
try:
os.path.chmod(out_file, mode)
except AttributeError:
pass
out_file = fp
#
# Main decoding loop
#
s = in_file.readline()
while s and s.strip() != 'end':
try:
data = binascii.a2b_uu(s)
except binascii.Error, v:
# Workaround for broken uuencoders by /Fredrik Lundh
nbytes = (((ord(s[0])-32) & 63) * 4 + 5) / 3
data = binascii.a2b_uu(s[:nbytes])
if not quiet:
sys.stderr.write("Warning: %s\n" % str(v))
out_file.write(data)
s = in_file.readline()
# if not s:
# raise Error, 'Truncated input file'
return (hdrfields[2].rstrip(), start_pos, in_file.tell())
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
Welcome to the Bugzilla documentation project!
You'll find these directories and files here:
README.docs # This README file
html/ # The compiled HTML docs from XML sources (do not edit)
txt/ # The compiled text docs from XML sources (do not edit)
xml/ # The original XML doc sources (edit these)
A note about the XML:
The documentation is written in DocBook 4.1.2, and attempts to adhere
to the LinuxDoc standards where applicable (http://www.tldp.org).
Please consult "The LDP Author Guide" at tldp.org for details on how
to set up your personal environment for compiling XML files.
If you need to make corrections to typographical errors, or other minor
editing duties, feel free to use any text editor to make the changes. XML
is not rocket science -- simply make sure your text appears between
appropriate tags (like <para>This is a paragraph</para>) and we'll be fine.
If you are making more extensive changes, please ensure you at least validate
your XML before checking it in with something like:
nsgmls -s $JADE_PUB/xml.dcl Bugzilla-Guide.xml
When you validate, please validate the master document (Bugzilla-Guide.xml)
as well as the document you edited to ensure there are no critical errors.
The following errors are considered "normal" when validating with nsgmls:
DTDDECL catalog entries are not supported
"DOCTYPE" declaration not allowed in instance
The reason these occur is that free sgml/xml validators do not yet support
the DTDDECL catalog entries, and I've included DOCTYPE declarations in
entities referenced from Bugzilla-Guide.xml so these entities can compile
individually, if necessary. I suppose I ought to comment them out at some
point, but for now they are convenient and don't hurt anything.
Thanks for taking the time to read these notes and consulting the
documentation. Please address comments and questions to the newsgroup:
news://news.mozilla.org/netscape/public/mozilla/webtools .
==========
HOW TO SET UP YOUR OWN XML EDITING ENVIRONMENT:
==========
Trying to set up an XML Docbook editing environment the
first time can be a daunting task.
I use Linux-Mandrake, in part, because it has a fully-functional
XML Docbook editing environment included as part of the
distribution CD's. If you have easier instructions for how to
do this for a particular Linux distribution or platform, please
let the team know at the mailing list: mozilla-webtools@mozilla.org.
The following text is taken nearly verbatim from
http://bugzilla.mozilla.org/show_bug.cgi?id=95970, where I gave
these instructions to someone who wanted the greater manageability
maintaining a document in Docbook brings:
This is just off the top of my head, but here goes. Note some of these may
NOT be necessary, but I don't think they hurt anything by being installed.
rpms:
openjade
jadetex
docbook-dtds
docbook-style-dsssl
docbook-style-dsssl-doc
docbook-utils
xemacs
psgml
sgml-tools
sgml-common
If you're getting these from RedHat, make sure you get the ones in the
rawhide area. The ones in the 7.2 distribution are too old and don't
include the XML stuff. The packages distrubuted with RedHat 8.0 and 9
and known to work.
Download "ldp.dsl" from the Resources page on tldp.org. This is the
stylesheet I use to get the HTML and text output. It works well, and has a
nice, consistent look with the rest of the linuxdoc documents. You'll have to
adjust the paths in ldp.dsl at the top of the file to reflect the actual
locations of your docbook catalog files. I created a directory,
/usr/share/sgml/docbook/ldp, and put the ldp.dsl file there. I then edited
ldp.dsl and changed two lines near the top:
<!ENTITY docbook.dsl SYSTEM "../dsssl-stylesheets/html/docbook.dsl" CDATA
dsssl>
...and...
<!ENTITY docbook.dsl SYSTEM "../dsssl-stylesheets/print/docbook.dsl" CDATA
dsssl>
Note the difference is the top one points to the HTML docbook stylesheet,
and the next one points to the PRINT docbook stylesheet.
Also note that modifying ldp.dsl doesn't seem to be needed on RedHat 9.
You know, this sure looks awful involved. Anyway, once you have this in
place, add to your .bashrc:
export SGML_CATALOG_FILES=/etc/sgml/catalog
export LDP_HOME=/usr/share/sgml/docbook/ldp
export JADE_PUB=/usr/share/doc/openjade-1.3.1/pubtext
or in .tcshrc:
setenv SGML_CATALOG_FILES /etc/sgml/catalog
setenv LDP_HOME /usr/share/sgml/docbook/ldp
setenv JADE_PUB /usr/share/doc/openjade-1.3.1/pubtext
If you have root access and want to set this up for anyone on your box,
you can add those lines to /etc/profile for bash users and /etc/csh.login
for tcsh users.
Make sure you edit the paths in the above environment variables if those
folders are anywhere else on your system (for example, the openjade version
might change if you get a new version at some point).
I suggest xemacs for editing your XML Docbook documents. The darn
thing just works, and generally includes PSGML mode by default. Not to
mention you can validate the SGML from right within it without having to
remember the command-line syntax for nsgml (not that it's that hard
anyway). If not, you can download psgml at
http://www.sourceforge.net/projects/psgml.
Another good editor is the latest releases of vim and gvim. Vim will
recognize DocBook tags and give them a different color than unreconized tags.
==========
NOTES:
==========
Here are the commands I use to maintain this documentation.
You MUST have DocBook 4.1.2 set up correctly in order for this to work.
These commands can be run all at once using the ./makedocs.pl script.
To create HTML documentation:
bash$ cd html
bash$ jade -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
$JADE_PUB/xml.dcl ../xml/Bugzilla-Guide.xml
To create HTML documentation as a single big HTML file:
bash$ cd html
bash$ jade -V nochunks -t sgml -i html -d $LDP_HOME/ldp.dsl\#html \
$JADE_PUB/xml.dcl ../xml/Bugzilla-Guide.xml >Bugzilla-Guide.html
To create TXT documentation as a single big TXT file:
bash$ cd txt
bash$ lynx -dump -nolist ../html/Bugzilla-Guide.html >Bugzilla-Guide.txt
Sincerely,
Matthew P. Barnson
The Bugzilla "Doc Knight"
mbarnson@sisna.com
with major edits by Dave Miller <justdave@syndicomm.com> based on
experience setting this up on the Landfill test server.
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<!-- Keep these tools listings in alphabetical order please. -MPB -->
<section id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai"
xreflabel="Bonsai, the Mozilla automated CVS management system">
<title>Bonsai</title>
<para>Bonsai is a web-based tool for managing
<xref linkend="cvs" />
. Using Bonsai, administrators can control open/closed status of trees,
query a fast relational database back-end for change, branch, and comment
information, and view changes made since the last time the tree was
closed. Bonsai
also integrates with
<xref linkend="tinderbox" />.
</para>
</section>
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
<title>CVS</title>
<para>CVS integration is best accomplished, at this point, using the
Bugzilla Email Gateway.</para>
<para>Follow the instructions in this Guide for enabling Bugzilla e-mail
integration. Ensure that your check-in script sends an email to your
Bugzilla e-mail gateway with the subject of
<quote>[Bug XXXX]</quote>,
and you can have CVS check-in comments append to your Bugzilla bug. If
you want to have the bug be closed automatically, you'll have to modify
the <filename>contrib/bugzilla_email_append.pl</filename> script.
</para>
<para>There is also a CVSZilla project, based upon somewhat dated
Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at: <ulink url="http://www.cvszilla.org/"/>.
</para>
<para>Another system capable of CVS integration with Bugzilla is
Scmbug. This system provides generic integration of Source code
Configuration Management with Bugtracking. Check it out at: <ulink
url="http://freshmeat.net/projects/scmbug/"/>.
</para>
</section>
<section id="scm"
xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
<title>Perforce SCM</title>
<para>You can find the project page for Bugzilla and Teamtrack Perforce
integration (p4dti) at:
<ulink url="http://www.ravenbrook.com/project/p4dti/"/>
.
<quote>p4dti</quote>
is now an officially supported product from Perforce, and you can find
the "Perforce Public Depot" p4dti page at
<ulink url="http://public.perforce.com/public/perforce/p4dti/index.html"/>
.</para>
<para>Integration of Perforce with Bugzilla, once patches are applied, is
seamless. Perforce replication information will appear below the comments
of each bug. Be certain you have a matching set of patches for the
Bugzilla version you are installing. p4dti is designed to support
multiple defect trackers, and maintains its own documentation for it.
Please consult the pages linked above for further information.</para>
</section>
<section id="svn"
xreflabel="Subversion, a compelling replacement for CVS">
<title>Subversion</title>
<para>Subversion is a free/open-source version control system,
designed to overcome various limitations of CVS. Integration of
Subversion with Bugzilla is possible using Scmbug, a system
providing generic integration of Source Code Configuration
Management with Bugtracking. Scmbug is available at <ulink
url="http://freshmeat.net/projects/scmbug/"/>.</para>
</section>
<section id="tinderbox"
xreflabel="Tinderbox, the Mozilla automated build management system">
<title>Tinderbox/Tinderbox2</title>
<para>Tinderbox is a continuous-build system which can integrate with
Bugzilla - see
<ulink url="http://www.mozilla.org/projects/tinderbox"/> for details
of Tinderbox, and
<ulink url="http://tinderbox.mozilla.org/showbuilds.cgi"/> to see it
in action.</para>
</section>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<chapter id="introduction">
<title>Introduction</title>
<section id="whatis">
<title>What is Bugzilla?</title>
<para>
Bugzilla is a bug- or issue-tracking system. Bug-tracking
systems allow individual or groups of developers effectively to keep track
of outstanding problems with their product.
Bugzilla was originally
written by Terry Weissman in a programming language called TCL, to
replace a rudimentary bug-tracking database used internally by Netscape
Communications. Terry later ported Bugzilla to Perl from TCL, and in Perl
it remains to this day. Most commercial defect-tracking software vendors
at the time charged enormous licensing fees, and Bugzilla quickly became
a favorite of the open-source crowd (with its genesis in the open-source
browser project, Mozilla). It is now the de-facto standard
defect-tracking system against which all others are measured.
</para>
<para>Bugzilla boasts many advanced features. These include:
<itemizedlist>
<listitem>
<para>Powerful searching</para>
</listitem>
<listitem>
<para>User-configurable email notifications of bug changes</para>
</listitem>
<listitem>
<para>Full change history</para>
</listitem>
<listitem>
<para>Inter-bug dependency tracking and graphing</para>
</listitem>
<listitem>
<para>Excellent attachment management</para>
</listitem>
<listitem>
<para>Integrated, product-based, granular security schema</para>
</listitem>
<listitem>
<para>Fully security-audited, and runs under Perl's taint mode</para>
</listitem>
<listitem>
<para>A robust, stable RDBMS back-end</para>
</listitem>
<listitem>
<para>Web, XML, email and console interfaces</para>
</listitem>
<listitem>
<para>Completely customisable and/or localisable web user
interface</para>
</listitem>
<listitem>
<para>Extensive configurability</para>
</listitem>
<listitem>
<para>Smooth upgrade pathway between versions</para>
</listitem>
</itemizedlist>
</para>
</section>
<section id="why">
<title>Why Should We Use Bugzilla?</title>
<para>For many years, defect-tracking software has remained principally
the domain of large software development houses. Even then, most shops
never bothered with bug-tracking software, and instead simply relied on
shared lists and email to monitor the status of defects. This procedure
is error-prone and tends to cause those bugs judged least significant by
developers to be dropped or ignored.</para>
<para>These days, many companies are finding that integrated
defect-tracking systems reduce downtime, increase productivity, and raise
customer satisfaction with their systems. Along with full disclosure, an
open bug-tracker allows manufacturers to keep in touch with their clients
and resellers, to communicate about problems effectively throughout the
data management chain. Many corporations have also discovered that
defect-tracking helps reduce costs by providing IT support
accountability, telephone support knowledge bases, and a common,
well-understood system for accounting for unusual system or software
issues.</para>
<para>But why should
<emphasis>you</emphasis>
use Bugzilla?</para>
<para>Bugzilla is very adaptable to various situations. Known uses
currently include IT support queues, Systems Administration deployment
management, chip design and development problem tracking (both
pre-and-post fabrication), and software and hardware bug tracking for
luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems.
Combined with systems such as
<ulink url="http://www.cvshome.org">CVS</ulink>,
<ulink url="http://www.mozilla.org/bonsai.html">Bonsai</ulink>, or
<ulink url="http://www.perforce.com">Perforce SCM</ulink>, Bugzilla
provides a powerful, easy-to-use solution to configuration management and
replication problems.</para>
<para>Bugzilla can dramatically increase the productivity and
accountability of individual employees by providing a documented workflow
and positive feedback for good performance. How many times do you wake up
in the morning, remembering that you were supposed to do
<emphasis>something</emphasis>
today, but you just can't quite remember? Put it in Bugzilla, and you
have a record of it from which you can extrapolate milestones, predict
product versions for integration, and follow the discussion trail
that led to critical decisions.</para>
<para>Ultimately, Bugzilla puts the power in your hands to improve your
value to your employer or business while providing a usable framework for
your natural attention to detail and knowledge store to flourish.</para>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
......@@ -21,7 +21,7 @@
<warning>
<para>
These files pre-date the templatisation work done as part of the
These files pre-date the templatization work done as part of the
2.16 release, and have not been updated.
</para>
</warning>
......
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="downloadlinks">
<title>Software Download Links</title>
<para>
All of these sites are current as of April, 2001. Hopefully
they'll stay current for a while.
</para>
<para>
Apache Web Server: <ulink url="http://www.apache.org/">http://www.apache.org</ulink>
Optional web server for Bugzilla, but recommended because of broad user base and support.
</para>
<para>
Bugzilla: <ulink url="http://www.mozilla.org/projects/bugzilla/">
http://www.mozilla.org/projects/bugzilla/</ulink>
</para>
<para>
MySQL: <ulink url="http://www.mysql.com/">http://www.mysql.com/</ulink>
</para>
<para>
Perl: <ulink url="http://www.perl.org">http://www.perl.org/</ulink>
</para>
<para>
CPAN: <ulink url="http://www.cpan.org/">http://www.cpan.org/</ulink>
</para>
<para>
DBI Perl module:
<ulink url="http://www.cpan.org/modules/by-module/DBI/">
http://www.cpan.org/modules/by-module/DBI/</ulink>
</para>
<para>
Data::Dumper module:
<ulink url="http://www.cpan.org/modules/by-module/Data/">
http://www.cpan.org/modules/by-module/Data/</ulink>
</para>
<para>
MySQL related Perl modules:
<ulink url="http://www.cpan.org/modules/by-module/Mysql/">
http://www.cpan.org/modules/by-module/Mysql/</ulink>
</para>
<para>
TimeDate Perl module collection:
<ulink url="http://www.cpan.org/modules/by-module/Date/">
http://www.cpan.org/modules/by-module/Date/</ulink>
</para>
<para>
GD Perl module:
<ulink url="http://www.cpan.org/modules/by-module/GD/">
http://www.cpan.org/modules/by-module/GD/</ulink>
Alternately, you should be able to find the latest version of
GD at <ulink url="http://www.boutell.com/gd/">http://www.boutell.com/gd/</ulink>
</para>
<para>
Chart::Base module:
<ulink url="http://www.cpan.org/modules/by-module/Chart/">
http://www.cpan.org/modules/by-module/Chart/</ulink>
</para>
<para>
LinuxDoc Software:
<ulink url="http://www.linuxdoc.org/">http://www.linuxdoc.org/</ulink>
(for documentation maintenance)
</para>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
*.html
Bugzilla
contrib
/* The contents of this file are subject to the Mozilla Public
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is the Bugzilla Bug Tracking System.
*
* The Initial Developer of the Original Code is Everything Solved.
* Portions created by Everything Solved are Copyright (C) 2006
* Everything Solved. All Rights Reserved.
*
* Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
*/
body {
background: white;
color: #111;
padding: 0 1em;
margin: 0;
font-family: Verdana, Arial, sans-serif;
font-size: small;
}
a:link, a:active { color: #36415c; }
a:visited { color: #666; }
a:hover { color: #888; }
h1 {
font-size: 150%;
font-weight: bold;
border-bottom: 2px solid #ccc;
}
h2 {
font-size: 125%;
font-weight: bold;
border-bottom: 1px solid #ccc;
margin-bottom: 8px;
}
h3 {
font-size: 115%;
font-weight: bold;
margin-bottom: 0;
padding-bottom: 0;
}
/* This makes Description/Params/Returns look nice. */
dd { margin-top: .2em; }
dd p { margin-top: 0; }
dl { margin-bottom: 1em; }
/* This makes the names of functions slightly larger, in Gecko. */
body > dl > dt code { font-size: 1.35em; }
#pod h1 a, #pod h2 a, #pod h3 a {
color: #36415c;
text-decoration: none;
}
pre, code, tt, kbd, samp {
/* Unfortunately, the default monospace fonts on most browsers
look odd with relative sizing. */
font-size: 12px;
}
.code {
background: #eed;
border: 1px solid #ccc;
}
pre.code {
margin-left: 10px;
width: 90%;
padding: 10px;
}
/* Special styles for the Contents page */
.contentspage dt {
font-size: large;
font-weight: bold;
}
.pod_desc_table {
border-collapse: collapse;
table-layout: auto;
border: 1px solid #ccc;
}
.pod_desc_table th {
text-align: left;
}
.pod_desc_table td, .pod_desc_table th {
padding: .25em;
border-top: 1px solid #ccc;
}
.pod_desc_table .odd th, .pod_desc_table .odd td {
background-color: #eee;
}
.pod_desc_table
<?xml version="1.0" encoding="UTF-8"?>
<dia:diagram xmlns:dia="http://www.lysator.liu.se/~alla/dia/">
<dia:diagramdata>
<dia:attribute name="background">
<dia:color val="#ffffff"/>
</dia:attribute>
<dia:attribute name="pagebreak">
<dia:color val="#000099"/>
</dia:attribute>
<dia:attribute name="paper">
<dia:composite type="paper">
<dia:attribute name="name">
<dia:string>#A4#</dia:string>
</dia:attribute>
<dia:attribute name="tmargin">
<dia:real val="2.8222000598907471"/>
</dia:attribute>
<dia:attribute name="bmargin">
<dia:real val="2.8222000598907471"/>
</dia:attribute>
<dia:attribute name="lmargin">
<dia:real val="2.8222000598907471"/>
</dia:attribute>
<dia:attribute name="rmargin">
<dia:real val="2.8222000598907471"/>
</dia:attribute>
<dia:attribute name="is_portrait">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="scaling">
<dia:real val="1"/>
</dia:attribute>
<dia:attribute name="fitto">
<dia:boolean val="false"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
<dia:attribute name="grid">
<dia:composite type="grid">
<dia:attribute name="width_x">
<dia:real val="1"/>
</dia:attribute>
<dia:attribute name="width_y">
<dia:real val="1"/>
</dia:attribute>
<dia:attribute name="visible_x">
<dia:int val="1"/>
</dia:attribute>
<dia:attribute name="visible_y">
<dia:int val="1"/>
</dia:attribute>
<dia:composite type="color"/>
</dia:composite>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#d8e5e5"/>
</dia:attribute>
<dia:attribute name="guides">
<dia:composite type="guides">
<dia:attribute name="hguides"/>
<dia:attribute name="vguides"/>
</dia:composite>
</dia:attribute>
</dia:diagramdata>
<dia:layer name="Background" visible="true">
<dia:object type="Standard - Line" version="0" id="O0">
<dia:attribute name="obj_pos">
<dia:point val="21,0"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="20.5,-0.05;21.5,2.05"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="21,0"/>
<dia:point val="21,2"/>
</dia:attribute>
<dia:attribute name="numcp">
<dia:int val="2"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="1" to="O10" connection="2"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O1">
<dia:attribute name="obj_pos">
<dia:point val="21,4"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="15.5,3.95;21.05,7.05"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="21,4"/>
<dia:point val="21,6.95"/>
<dia:point val="16,4"/>
<dia:point val="16,7"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O10" connection="13"/>
<dia:connection handle="3" to="O11" connection="2"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O2">
<dia:attribute name="obj_pos">
<dia:point val="10,4"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="9.95,3.95;16.5,7.05"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="10,4"/>
<dia:point val="10,7"/>
<dia:point val="16,4"/>
<dia:point val="16,7"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="3" to="O11" connection="2"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Line" version="0" id="O3">
<dia:attribute name="obj_pos">
<dia:point val="16,8.9"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="15.5,8.85;16.5,12.05"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="16,8.9"/>
<dia:point val="16,12"/>
</dia:attribute>
<dia:attribute name="numcp">
<dia:int val="1"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O11" connection="13"/>
<dia:connection handle="1" to="O12" connection="2"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Arc" version="0" id="O4">
<dia:attribute name="obj_pos">
<dia:point val="13,13"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="10.95,7.9;13.5,13.05"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="13,13"/>
<dia:point val="13,7.95"/>
</dia:attribute>
<dia:attribute name="curve_distance">
<dia:real val="-1.9999999999999998"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O12" connection="7"/>
<dia:connection handle="1" to="O11" connection="7"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Line" version="0" id="O5">
<dia:attribute name="obj_pos">
<dia:point val="16,14"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="15.5,13.95;16.5,17.05"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="16,14"/>
<dia:point val="16,17"/>
</dia:attribute>
<dia:attribute name="numcp">
<dia:int val="1"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O12" connection="13"/>
<dia:connection handle="1" to="O13" connection="2"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Line" version="0" id="O6">
<dia:attribute name="obj_pos">
<dia:point val="10,3"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="9.95,2.95;10.05,4.05"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="10,3"/>
<dia:point val="10,4"/>
</dia:attribute>
<dia:attribute name="numcp">
<dia:int val="2"/>
</dia:attribute>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O7">
<dia:attribute name="obj_pos">
<dia:point val="16,18.9"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="15.95,18.85;21.5,22.05"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="16,18.9"/>
<dia:point val="16,22"/>
<dia:point val="21,19"/>
<dia:point val="21,22"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O13" connection="13"/>
<dia:connection handle="3" to="O14" connection="2"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O8">
<dia:attribute name="obj_pos">
<dia:point val="16,18.9"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="9.5,18.85;16.05,22.05"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="16,18.9"/>
<dia:point val="16,22"/>
<dia:point val="10,19"/>
<dia:point val="10,22"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O13" connection="13"/>
<dia:connection handle="3" to="O15" connection="2"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Arc" version="0" id="O9">
<dia:attribute name="obj_pos">
<dia:point val="8.5,22"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="8.4318,13.5624;13.6055,22.0682"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="8.5,22"/>
<dia:point val="13.1464,13.8536"/>
</dia:attribute>
<dia:attribute name="curve_distance">
<dia:real val="-0.71725063066182693"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O15" connection="1"/>
<dia:connection handle="1" to="O12" connection="11"/>
</dia:connections>
</dia:object>
<dia:object type="Flowchart - Box" version="0" id="O10">
<dia:attribute name="obj_pos">
<dia:point val="17.9,2"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="17.85,1.95;24.15,4.05"/>
</dia:attribute>
<dia:attribute name="elem_corner">
<dia:point val="17.9,2"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="6.1999999999999993"/>
</dia:attribute>
<dia:attribute name="elem_height">
<dia:real val="2"/>
</dia:attribute>
<dia:attribute name="inner_color">
<dia:color val="#e5e5e5"/>
</dia:attribute>
<dia:attribute name="show_background">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="corner_radius">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="padding">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#UNCONFIRMED#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="80" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.80000000000000004"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="21,3.3"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="1"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Flowchart - Box" version="0" id="O11">
<dia:attribute name="obj_pos">
<dia:point val="13,7"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="12.95,6.95;19.05,8.95"/>
</dia:attribute>
<dia:attribute name="elem_corner">
<dia:point val="13,7"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="6"/>
</dia:attribute>
<dia:attribute name="elem_height">
<dia:real val="1.9000000000000001"/>
</dia:attribute>
<dia:attribute name="show_background">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="corner_radius">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="padding">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#NEW#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="80" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.80000000000000004"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="16,8.25"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="1"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Flowchart - Box" version="0" id="O12">
<dia:attribute name="obj_pos">
<dia:point val="13,12"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="12.95,11.95;19.05,14.05"/>
</dia:attribute>
<dia:attribute name="elem_corner">
<dia:point val="13,12"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="6"/>
</dia:attribute>
<dia:attribute name="elem_height">
<dia:real val="2"/>
</dia:attribute>
<dia:attribute name="show_background">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="corner_radius">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="padding">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#ASSIGNED#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="80" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.80000000000000004"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="16,13.3"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="1"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Flowchart - Box" version="0" id="O13">
<dia:attribute name="obj_pos">
<dia:point val="13,17"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="12.95,16.95;19.05,18.95"/>
</dia:attribute>
<dia:attribute name="elem_corner">
<dia:point val="13,17"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="6"/>
</dia:attribute>
<dia:attribute name="elem_height">
<dia:real val="1.9000000000000001"/>
</dia:attribute>
<dia:attribute name="inner_color">
<dia:color val="#bfbfbf"/>
</dia:attribute>
<dia:attribute name="show_background">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="corner_radius">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="padding">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#RESOLVED#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="80" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.80000000000000004"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="16,18.25"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="1"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Flowchart - Box" version="0" id="O14">
<dia:attribute name="obj_pos">
<dia:point val="18,22"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="17.95,21.95;24.05,23.95"/>
</dia:attribute>
<dia:attribute name="elem_corner">
<dia:point val="18,22"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="6"/>
</dia:attribute>
<dia:attribute name="elem_height">
<dia:real val="1.9000000000000001"/>
</dia:attribute>
<dia:attribute name="inner_color">
<dia:color val="#bfbfbf"/>
</dia:attribute>
<dia:attribute name="show_background">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="corner_radius">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="padding">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#VERIFIED#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="80" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.80000000000000004"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="21,23.25"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="1"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Flowchart - Box" version="0" id="O15">
<dia:attribute name="obj_pos">
<dia:point val="7,22"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="6.95,21.95;13.05,23.95"/>
</dia:attribute>
<dia:attribute name="elem_corner">
<dia:point val="7,22"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="6"/>
</dia:attribute>
<dia:attribute name="elem_height">
<dia:real val="1.9000000000000001"/>
</dia:attribute>
<dia:attribute name="show_background">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="corner_radius">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="padding">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#REOPEN#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="80" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.80000000000000004"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="10,23.25"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="1"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Flowchart - Box" version="0" id="O16">
<dia:attribute name="obj_pos">
<dia:point val="13,27"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="12.95,26.95;19.05,28.95"/>
</dia:attribute>
<dia:attribute name="elem_corner">
<dia:point val="13,27"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="6"/>
</dia:attribute>
<dia:attribute name="elem_height">
<dia:real val="1.9000000000000001"/>
</dia:attribute>
<dia:attribute name="inner_color">
<dia:color val="#bfbfbf"/>
</dia:attribute>
<dia:attribute name="show_background">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="corner_radius">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="padding">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#CLOSED#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="80" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.80000000000000004"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="16,28.25"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="1"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O17">
<dia:attribute name="obj_pos">
<dia:point val="21,23.9"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="15.5,23.85;21.05,27.05"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="21,23.9"/>
<dia:point val="21,27"/>
<dia:point val="16,24"/>
<dia:point val="16,27"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O14" connection="13"/>
<dia:connection handle="3" to="O16" connection="2"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O18">
<dia:attribute name="obj_pos">
<dia:point val="19,17.95"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="18.945,17.8995;25.05,28.4505"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="19,17.95"/>
<dia:point val="24,18"/>
<dia:point val="25,21"/>
<dia:point val="25,23"/>
<dia:point val="25,25"/>
<dia:point val="24,28"/>
<dia:point val="19,27.95"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O13" connection="8"/>
<dia:connection handle="6" to="O16" connection="8"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Line" version="0" id="O19">
<dia:attribute name="obj_pos">
<dia:point val="18,22.95"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="12.95,22.45;18.05,23.45"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="18,22.95"/>
<dia:point val="13,22.95"/>
</dia:attribute>
<dia:attribute name="numcp">
<dia:int val="1"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O14" connection="7"/>
<dia:connection handle="1" to="O15" connection="8"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O20">
<dia:attribute name="obj_pos">
<dia:point val="14.5,27"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="9.5,23.85;14.5851,27.0575"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="14.5,27"/>
<dia:point val="15,24"/>
<dia:point val="10,27"/>
<dia:point val="10,23.9"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O16" connection="1"/>
<dia:connection handle="3" to="O15" connection="13"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Arc" version="0" id="O21">
<dia:attribute name="obj_pos">
<dia:point val="8.5,22"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="8.42939,17.5449;13.3716,22.0706"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="8.5,22"/>
<dia:point val="13,17.95"/>
</dia:attribute>
<dia:attribute name="curve_distance">
<dia:real val="-0.74169570721594136"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O15" connection="1"/>
<dia:connection handle="1" to="O13" connection="7"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Arc" version="0" id="O22">
<dia:attribute name="obj_pos">
<dia:point val="19,7.95"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="18.5,7.9;22.05,17.525"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="19,7.95"/>
<dia:point val="19,17.475"/>
</dia:attribute>
<dia:attribute name="curve_distance">
<dia:real val="-3"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O11" connection="8"/>
<dia:connection handle="1" to="O13" connection="6"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Arc" version="0" id="O23">
<dia:attribute name="obj_pos">
<dia:point val="21,4"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="18.4981,3.9432;23.6948,17.5979"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="21,4"/>
<dia:point val="19,17.475"/>
</dia:attribute>
<dia:attribute name="curve_distance">
<dia:real val="-3.5943353432190368"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O10" connection="13"/>
<dia:connection handle="1" to="O13" connection="6"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Arc" version="0" id="O24">
<dia:attribute name="obj_pos">
<dia:point val="21,4"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="18.5011,3.94034;21.8578,13.1573"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="21,4"/>
<dia:point val="19,13"/>
</dia:attribute>
<dia:attribute name="curve_distance">
<dia:real val="-1.6769027424613245"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O10" connection="13"/>
<dia:connection handle="1" to="O12" connection="8"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O25">
<dia:attribute name="obj_pos">
<dia:point val="10.025,0.825"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="7.2,0.225;12.85,3.225"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#New bug from a
user with canconfirm
or a product without
UNCONFIRMED state#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.69999999999999996"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="10.025,0.825"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="1"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O26">
<dia:attribute name="obj_pos">
<dia:point val="20.325,4.48321"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="14.675,3.93321;20.325,5.28321"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Bug confirmed or
receives enough votes#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="20.325,4.48321"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="2"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O27">
<dia:attribute name="obj_pos">
<dia:point val="16.2865,10.1"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="16.2865,9.55;20.3865,10.9"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Developer takes
possession#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="16.2865,10.1"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O28">
<dia:attribute name="obj_pos">
<dia:point val="10.7629,9.45"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="8.0629,8.8825;10.7804,10.285"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Ownership
is changed#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="10.7629,9.45"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="2"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O29">
<dia:attribute name="obj_pos">
<dia:point val="21.4576,6.43623"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="17.3576,5.88623;21.4576,7.23623"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Developer takes
possession#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="21.4576,6.43623"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="2"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Flowchart - Box" version="0" id="O30">
<dia:attribute name="obj_pos">
<dia:point val="4.81289,11.0073"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="4.76289,10.9573;10.5629,16.2573"/>
</dia:attribute>
<dia:attribute name="elem_corner">
<dia:point val="4.81289,11.0073"/>
</dia:attribute>
<dia:attribute name="elem_width">
<dia:real val="5.6999999999999993"/>
</dia:attribute>
<dia:attribute name="elem_height">
<dia:real val="5.1999999999999993"/>
</dia:attribute>
<dia:attribute name="inner_color">
<dia:color val="#bfbfbf"/>
</dia:attribute>
<dia:attribute name="show_background">
<dia:boolean val="true"/>
</dia:attribute>
<dia:attribute name="corner_radius">
<dia:real val="0.10000000000000001"/>
</dia:attribute>
<dia:attribute name="padding">
<dia:real val="0.14999999999999999"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Possible resolutions:
FIXED
DUPLICATE
WONTFIX
WORKSFORME
INVALID#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="4.91289,11.7573"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Line" version="0" id="O31">
<dia:attribute name="obj_pos">
<dia:point val="10.3629,14.9073"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="10.3278,14.8722;13.1815,17.1815"/>
</dia:attribute>
<dia:attribute name="conn_endpoints">
<dia:point val="10.3629,14.9073"/>
<dia:point val="13.1464,17.1464"/>
</dia:attribute>
<dia:attribute name="numcp">
<dia:int val="1"/>
</dia:attribute>
<dia:attribute name="line_width">
<dia:real val="0.050000000000000003"/>
</dia:attribute>
<dia:attribute name="line_style">
<dia:enum val="4"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O30" connection="10"/>
<dia:connection handle="1" to="O13" connection="0"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O32">
<dia:attribute name="obj_pos">
<dia:point val="16.299,15.3073"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="16.299,14.7573;20.449,16.1073"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Development is
finished with bug#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="16.299,15.3073"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O33">
<dia:attribute name="obj_pos">
<dia:point val="11.4365,21"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="11.4365,20.45;15.5365,21.8"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#QA not satisfied
with solution#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="11.4365,21"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O34">
<dia:attribute name="obj_pos">
<dia:point val="16.8365,21.05"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="16.8365,20.5;20.7365,21.85"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#QA verifies
solution worked#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="16.8365,21.05"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O35">
<dia:attribute name="obj_pos">
<dia:point val="17.224,25.875"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="17.224,25.325;20.574,26.075"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Bug is closed#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="17.224,25.875"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O36">
<dia:attribute name="obj_pos">
<dia:point val="22.5365,18.5"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="22.5365,17.95;25.8865,18.7"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Bug is closed#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="22.5365,18.5"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O37">
<dia:attribute name="obj_pos">
<dia:point val="9.62401,17.8111"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="5.52401,17.2611;9.62401,18.6111"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Developer takes
possession#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="9.62401,17.8111"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="2"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O38">
<dia:attribute name="obj_pos">
<dia:point val="11.1865,19.15"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="11.1865,18.6;13.3365,19.95"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Issue is
resolved#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="11.1865,19.15"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O39">
<dia:attribute name="obj_pos">
<dia:point val="11.049,25.325"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="11.049,24.775;15.049,25.525"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Bug is reopened#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="11.049,25.325"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O40">
<dia:attribute name="obj_pos">
<dia:point val="13.9365,22.75"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="13.9365,22.2;17.9365,22.95"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Bug is reopened#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="13.9365,22.75"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O41">
<dia:attribute name="obj_pos">
<dia:point val="19,17.95"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="18.9494,3.46851;29.05,18.0006"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="19,17.95"/>
<dia:point val="23,18"/>
<dia:point val="29,14"/>
<dia:point val="29,11"/>
<dia:point val="29,8"/>
<dia:point val="27,7"/>
<dia:point val="23.9286,3.85355"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O13" connection="8"/>
<dia:connection handle="6" to="O10" connection="15"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O42">
<dia:attribute name="obj_pos">
<dia:point val="24,10"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="24,9.45;28.15,10.8"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Development is
finished with bug#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="24,10"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O43">
<dia:attribute name="obj_pos">
<dia:point val="23.8536,22.1464"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="23.5359,3.46851;29.0712,22.2033"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="23.8536,22.1464"/>
<dia:point val="29.6426,21.2696"/>
<dia:point val="29,14"/>
<dia:point val="29,11"/>
<dia:point val="29,8"/>
<dia:point val="27,7"/>
<dia:point val="23.9286,3.85355"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O14" connection="4"/>
<dia:connection handle="6" to="O10" connection="15"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - BezierLine" version="0" id="O44">
<dia:attribute name="obj_pos">
<dia:point val="18.8536,28.7536"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="18.8032,3.46851;29.05,28.8043"/>
</dia:attribute>
<dia:attribute name="bez_points">
<dia:point val="18.8536,28.7536"/>
<dia:point val="28.0326,28.8213"/>
<dia:point val="29,24"/>
<dia:point val="29,21"/>
<dia:point val="29,18"/>
<dia:point val="29,14"/>
<dia:point val="29,11"/>
<dia:point val="29,8"/>
<dia:point val="27,7"/>
<dia:point val="23.9286,3.85355"/>
</dia:attribute>
<dia:attribute name="corner_types">
<dia:enum val="0"/>
<dia:enum val="0"/>
<dia:enum val="0"/>
<dia:enum val="0"/>
</dia:attribute>
<dia:attribute name="end_arrow">
<dia:enum val="22"/>
</dia:attribute>
<dia:attribute name="end_arrow_length">
<dia:real val="0.5"/>
</dia:attribute>
<dia:attribute name="end_arrow_width">
<dia:real val="0.5"/>
</dia:attribute>
<dia:connections>
<dia:connection handle="0" to="O16" connection="15"/>
<dia:connection handle="9" to="O10" connection="15"/>
</dia:connections>
</dia:object>
<dia:object type="Standard - Text" version="0" id="O45">
<dia:attribute name="obj_pos">
<dia:point val="25,4"/>
</dia:attribute>
<dia:attribute name="obj_bb">
<dia:rectangle val="25,3.45;30.1,4.8"/>
</dia:attribute>
<dia:attribute name="text">
<dia:composite type="text">
<dia:attribute name="string">
<dia:string>#Bug is reopened,
was never confirmed#</dia:string>
</dia:attribute>
<dia:attribute name="font">
<dia:font family="sans" style="0" name="Helvetica"/>
</dia:attribute>
<dia:attribute name="height">
<dia:real val="0.59999999999999998"/>
</dia:attribute>
<dia:attribute name="pos">
<dia:point val="25,4"/>
</dia:attribute>
<dia:attribute name="color">
<dia:color val="#000000"/>
</dia:attribute>
<dia:attribute name="alignment">
<dia:enum val="0"/>
</dia:attribute>
</dia:composite>
</dia:attribute>
</dia:object>
</dia:layer>
</dia:diagram>
File mode changed from 100644 to 100755
This source diff could not be displayed because it is too large. You can view the blob instead.
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
<!-- Include macros -->
<!ENTITY about SYSTEM "about.xml">
<!ENTITY conventions SYSTEM "conventions.xml">
<!ENTITY doc-index SYSTEM "index.xml">
<!ENTITY gfdl SYSTEM "gfdl.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
<!ENTITY installation SYSTEM "installation.xml">
<!ENTITY administration SYSTEM "administration.xml">
<!ENTITY security SYSTEM "security.xml">
<!ENTITY using SYSTEM "using.xml">
<!ENTITY integration SYSTEM "integration.xml">
<!ENTITY index SYSTEM "index.xml">
<!ENTITY customization SYSTEM "customization.xml">
<!ENTITY troubleshooting SYSTEM "troubleshooting.xml">
<!ENTITY patches SYSTEM "patches.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY modules SYSTEM "modules.xml">
<!-- Things to change for a stable release:
* bz-ver to current stable
* bz-nexver to next stable
* bz-date to the release date
* landfillbase to the branch install
* Remove the BZ-DEVEL comments
- COMPILE DOCS AND CHECKIN -
Also, tag and tarball before completing
* bz-ver to devel version
For a devel release, simple bump bz-ver and bz-date
-->
<!ENTITY bz-ver "3.1.3">
<!ENTITY bz-nextver "3.2">
<!ENTITY bz-date "2008-02-01">
<!ENTITY current-year "2008">
<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/">
<!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bzg-bugs "<ulink url='https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY min-perl-ver "5.8.1">
]>
<!-- Coding standards for this document
* Other than the GFDL, please use the "section" tag instead of "sect1",
"sect2", etc.
* Use Entities to include files for new chapters in Bugzilla-Guide.xml.
* Try to use Entities for frequently-used passages of text as well.
* Ensure all documents compile cleanly to HTML after modification.
The warning, "DTDDECL catalog types not supported" is normal.
* Try to index important terms wherever possible.
* Use "glossterm" whenever you introduce a new term.
* Follow coding standards at http://www.tldp.org, and
check out the KDE guidelines (they are nice, too)
http://i18n.kde.org/doc/markup.html
* All tags should be lowercase.
* Please use sensible spacing. The comments at the very end of each
file define reasonable defaults for PSGML mode in EMACS.
* Double-indent tags, use double spacing whenever possible, and
try to avoid clutter and feel free to waste space in the code to make it
more readable.
-->
<book id="index">
<!-- Header -->
<bookinfo>
<title>The Bugzilla Guide - &bz-ver;
<!-- BZ-DEVEL -->Development <!-- /BZ-DEVEL -->
Release</title>
<authorgroup>
<corpauthor>The Bugzilla Team</corpauthor>
</authorgroup>
<pubdate>&bz-date;</pubdate>
<abstract>
<para>
This is the documentation for Bugzilla, a
bug-tracking system from mozilla.org.
Bugzilla is an enterprise-class piece of software
that tracks millions of bugs and issues for hundreds of
organizations around the world.
</para>
<para>
The most current version of this document can always be found on the
<ulink url="http://www.bugzilla.org/docs/">Bugzilla
Documentation Page</ulink>.
</para>
</abstract>
<keywordset>
<keyword>Bugzilla</keyword>
<keyword>Guide</keyword>
<keyword>installation</keyword>
<keyword>FAQ</keyword>
<keyword>administration</keyword>
<keyword>integration</keyword>
<keyword>MySQL</keyword>
<keyword>Mozilla</keyword>
<keyword>webtools</keyword>
</keywordset>
</bookinfo>
<!-- About This Guide -->
&about;
<!-- Installing Bugzilla -->
&installation;
<!-- Administering Bugzilla -->
&administration;
<!-- Securing Bugzilla -->
&security;
<!-- Using Bugzilla -->
&using;
<!-- Customizing Bugzilla -->
&customization;
<!-- Appendix: Troubleshooting -->
&troubleshooting;
<!-- Appendix: Custom Patches -->
&patches;
<!-- Appendix: Manually Installing Perl Modules -->
&modules;
<!-- Appendix: GNU Free Documentation License -->
&gfdl;
<!-- Glossary -->
&glossary;
<!-- Index -->
&index;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY conventions SYSTEM "conventions.xml"> ] > -->
<!-- $Id: about.xml,v 1.26 2007/08/02 06:52:32 wurblzap%gmail.com Exp $ -->
<chapter id="about">
<title>About This Guide</title>
<section id="copyright">
<title>Copyright Information</title>
<para>This document is copyright (c) 2000-&current-year; by the various
Bugzilla contributors who wrote it.</para>
<blockquote>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License, Version 1.1 or any later version published by the
Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and with no Back-Cover Texts. A copy of
the license is included in <xref linkend="gfdl"/>.
</para>
</blockquote>
<para>
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
please contact the Bugzilla Team.
</para>
</section>
<section id="disclaimer">
<title>Disclaimer</title>
<para>
No liability for the contents of this document can be accepted.
Follow the instructions herein at your own risk.
This document may contain errors
and inaccuracies that may damage your system, cause your partner
to leave you, your boss to fire you, your cats to
pee on your furniture and clothing, and global thermonuclear
war. Proceed with caution.
</para>
<para>
Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". We
wholeheartedly endorse the use of GNU/Linux; it is an extremely
versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
</para>
<para>
Although the Bugzilla development team has taken great care to
ensure that all exploitable bugs have been fixed, security holes surely
exist in any piece of code. Great care should be taken both in
the installation and usage of this software. The Bugzilla development
team members assume no liability for your use of Bugzilla. You have
the source code, and are responsible for auditing it yourself to ensure
your security needs are met.
</para>
</section>
<!-- Section 2: New Versions -->
<section id="newversions">
<title>New Versions</title>
<para>
This is the &bz-ver; version of The Bugzilla Guide. It is so named
to match the current version of Bugzilla.
<!-- BZ-DEVEL --> This version of the guide, like its associated Bugzilla version, is a
development version.<!-- /BZ-DEVEL -->
</para>
<para>
The latest version of this guide can always be found at <ulink
url="http://www.bugzilla.org"/>, or checked out via CVS by
following the <ulink url="http://www.mozilla.org/cvs.html">Mozilla
CVS</ulink> instructions and check out the
<filename>mozilla/webtools/bugzilla/docs/</filename>
subtree. However, you should read the version
which came with the Bugzilla release you are using.
</para>
<para>
The Bugzilla Guide, or a section of it, is also available in
the following languages:
<ulink url="http://www.traduc.org/docs/guides/lecture/bugzilla/">French</ulink>,
<ulink url="http://bugzilla-de.sourceforge.net/docs/html/">German</ulink>,
<ulink url="http://www.bugzilla.jp/docs/2.18/">Japanese</ulink>.
Note that these may be outdated or not up to date.
</para>
<para>
In addition, there are Bugzilla template localization projects in
the following languages. They may have translated documentation
available:
<ulink url="http://sourceforge.net/projects/bugzilla-ar/">Arabic</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-be/">Belarusian</ulink>,
<ulink url="http://openfmi.net/projects/mozilla-bg/">Bulgarian</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-br/">Brazilian Portuguese</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-cn/">Chinese</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-fr/">French</ulink>,
<ulink url="http://germzilla.ganderbay.net/">German</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-it/">Italian</ulink>,
<ulink url="http://www.bugzilla.jp/about/jp.html">Japanese</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-kr/">Korean</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-ru/">Russian</ulink> and
<ulink url="http://sourceforge.net/projects/bugzilla-es/">Spanish</ulink>.
</para>
<para>
If you would like to volunteer to translate the Guide into additional
languages, please contact
<ulink url="mailto:justdave@bugzilla.org">Dave Miller</ulink>.
</para>
</section>
<section id="credits">
<title>Credits</title>
<para>
The people listed below have made enormous contributions to the
creation of this Guide, through their writing, dedicated hacking efforts,
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
</para>
<!-- TODO: This is evil... there has to be a valid way to get this look -->
<variablelist>
<varlistentry>
<term>Matthew P. Barnson <email>mbarnson@sisna.com</email></term>
<listitem>
<para>for the Herculean task of pulling together the Bugzilla Guide
and shepherding it to 2.14.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Terry Weissman <email>terry@mozilla.org</email></term>
<listitem>
<para>for initially writing Bugzilla and creating the README upon
which the UNIX installation documentation is largely based.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Tara Hernandez <email>tara@tequilarists.org</email></term>
<listitem>
<para>for keeping Bugzilla development going strong after Terry left
mozilla.org and for running landfill.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dave Lawrence <email>dkl@redhat.com</email></term>
<listitem>
<para>for providing insight into the key differences between Red
Hat's customized Bugzilla.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dawn Endico <email>endico@mozilla.org</email></term>
<listitem>
<para>for being a hacker extraordinaire and putting up with Matthew's
incessant questions and arguments on irc.mozilla.org in #mozwebtools
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Jacob Steenhagen <email>jake@bugzilla.org</email></term>
<listitem>
<para>for taking over documentation during the 2.17 development
period.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dave Miller <email>justdave@bugzilla.org</email></term>
<listitem>
<para>for taking over as project lead when Tara stepped down and
continually pushing for the documentation to be the best it can be.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Thanks also go to the following people for significant contributions
to this documentation:
<simplelist type="inline">
<member>Kevin Brannen</member>
<member>Vlad Dascalu</member>
<member>Ben FrantzDale</member>
<member>Eric Hanson</member>
<member>Zach Lipton</member>
<member>Gervase Markham</member>
<member>Andrew Pearson</member>
<member>Joe Robins</member>
<member>Spencer Smith</member>
<member>Ron Teitelbaum</member>
<member>Shane Travis</member>
<member>Martin Wulffeld</member>
</simplelist>.
</para>
<para>
Also, thanks are due to the members of the
<ulink url="news://news.mozilla.org/mozilla.support.bugzilla">
mozilla.support.bugzilla</ulink>
newsgroup (and its predecessor, netscape.public.mozilla.webtools).
Without your discussions, insight, suggestions, and patches,
this could never have happened.
</para>
</section>
<!-- conventions used here (didn't want to give it a chapter of its own) -->
&conventions;
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: -->
This source diff could not be displayed because it is too large. You can view the blob instead.
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<section id="conventions">
<title>Document Conventions</title>
<indexterm zone="conventions">
<primary>conventions</primary>
</indexterm>
<para>This document uses the following conventions:</para>
<informaltable frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Descriptions</entry>
<entry>Appearance</entry>
</row>
</thead>
<tbody>
<row>
<entry>Caution</entry>
<entry>
<caution>
<para>Don't run with scissors!</para>
</caution>
</entry>
</row>
<row>
<entry>Hint or Tip</entry>
<entry>
<tip>
<para>For best results... </para>
</tip>
</entry>
</row>
<row>
<entry>Note</entry>
<entry>
<note>
<para>Dear John...</para>
</note>
</entry>
</row>
<row>
<entry>Warning</entry>
<entry>
<warning>
<para>Read this or the cat gets it.</para>
</warning>
</entry>
</row>
<row>
<entry>File or directory name</entry>
<entry>
<filename>filename</filename>
</entry>
</row>
<row>
<entry>Command to be typed</entry>
<entry>
<command>command</command>
</entry>
</row>
<row>
<entry>Application name</entry>
<entry>
<application>application</application>
</entry>
</row>
<row>
<entry>
Normal user's prompt under bash shell</entry>
<entry>bash$</entry>
</row>
<row>
<entry>
Root user's prompt under bash shell</entry>
<entry>bash#</entry>
</row>
<row>
<entry>
Normal user's prompt under tcsh shell</entry>
<entry>tcsh$</entry>
</row>
<row>
<entry>Environment variables</entry>
<entry>
<envar>VARIABLE</envar>
</entry>
</row>
<row>
<entry>Term found in the glossary</entry>
<entry>
<glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
</entry>
</row>
<row>
<entry>Code example</entry>
<entry>
<programlisting><sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag></programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or XML diffs, attached
to a bug filed in the &bzg-bugs; component.
</para>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<chapter id="customization">
<title>Customizing Bugzilla</title>
<section id="cust-skins">
<title>Custom Skins</title>
<para>
Bugzilla allows you to have multiple skins. These are custom CSS and possibly
also custom images for Bugzilla. To create a new custom skin, you have two
choices:
<itemizedlist>
<listitem>
<para>
Make a single CSS file, and put it in the
<filename>skins/contrib</filename> directory.
</para>
</listitem>
<listitem>
<para>
Make a directory that contains all the same CSS file
names as <filename>skins/standard/</filename>, and put
your directory in <filename>skins/contrib/</filename>.
</para>
</listitem>
</itemizedlist>
</para>
<para>
After you put the file or the directory there, make sure to run checksetup.pl
so that it can reset the file permissions correctly.
</para>
<para>
After you have installed the new skin, it will show up as an option in the
user's General Preferences. If you would like to force a particular skin on all
users, just select it in the Default Preferences and then uncheck "Enabled" on
the preference.
</para>
</section>
<section id="cust-templates">
<title>Template Customization</title>
<para>
Administrators can configure the look and feel of Bugzilla without
having to edit Perl files or face the nightmare of massive merge
conflicts when they upgrade to a newer version in the future.
</para>
<para>
Templatization also makes localized versions of Bugzilla possible,
for the first time. It's possible to have Bugzilla's UI language
determined by the user's browser. More information is available in
<xref linkend="template-http-accept"/>.
</para>
<section id="template-directory">
<title>Template Directory Structure</title>
<para>
The template directory structure starts with top level directory
named <filename>template</filename>, which contains a directory
for each installed localization. The next level defines the
language used in the templates. Bugzilla comes with English
templates, so the directory name is <filename>en</filename>,
and we will discuss <filename>template/en</filename> throughout
the documentation. Below <filename>template/en</filename> is the
<filename>default</filename> directory, which contains all the
standard templates shipped with Bugzilla.
</para>
<warning>
<para>
A directory <filename>data/templates</filename> also exists;
this is where Template Toolkit puts the compiled versions of
the templates from either the default or custom directories.
<emphasis>Do not</emphasis> directly edit the files in this
directory, or all your changes will be lost the next time
Template Toolkit recompiles the templates.
</para>
</warning>
</section>
<section id="template-method">
<title>Choosing a Customization Method</title>
<para>
If you want to edit Bugzilla's templates, the first decision
you must make is how you want to go about doing so. There are two
choices, and which you use depends mainly on the scope of your
modifications, and the method you plan to use to upgrade Bugzilla.
</para>
<para>
The first method of making customizations is to directly edit the
templates found in <filename>template/en/default</filename>.
This is probably the best way to go about it if you are going to
be upgrading Bugzilla through CVS, because if you then execute
a <command>cvs update</command>, any changes you have made will
be merged automagically with the updated versions.
</para>
<note>
<para>
If you use this method, and CVS conflicts occur during an
update, the conflicted templates (and possibly other parts
of your installation) will not work until they are resolved.
</para>
</note>
<para>
The second method is to copy the templates to be modified
into a mirrored directory structure under
<filename>template/en/custom</filename>. Templates in this
directory structure automatically override any identically-named
and identically-located templates in the
<filename>default</filename> directory.
</para>
<note>
<para>
The <filename>custom</filename> directory does not exist
at first and must be created if you want to use it.
</para>
</note>
<para>
The second method of customization should be used if you
use the overwriting method of upgrade, because otherwise
your changes will be lost. This method may also be better if
you are using the CVS method of upgrading and are going to make major
changes, because it is guaranteed that the contents of this directory
will not be touched during an upgrade, and you can then decide whether
to continue using your own templates, or make the effort to merge your
changes into the new versions by hand.
</para>
<para>
Using this method, your installation may break if incompatible
changes are made to the template interface. Such changes should
be documented in the release notes, provided you are using a
stable release of Bugzilla. If you use using unstable code, you will
need to deal with this one yourself, although if possible the changes
will be mentioned before they occur in the deprecations section of the
previous stable release's release notes.
</para>
<note>
<para>
Regardless of which method you choose, it is recommended that
you run <command>./checksetup.pl</command> after creating or
editing any templates in the <filename>template/en/default</filename>
directory, and after editing any templates in the
<filename>custom</filename> directory.
</para>
</note>
<warning>
<para>
It is <emphasis>required</emphasis> that you run
<command>./checksetup.pl</command> after creating a new
template in the <filename>custom</filename> directory. Failure
to do so will raise an incomprehensible error message.
</para>
</warning>
</section>
<section id="template-edit">
<title>How To Edit Templates</title>
<note>
<para>
If you are making template changes that you intend on submitting back
for inclusion in standard Bugzilla, you should read the relevant
sections of the
<ulink url="http://www.bugzilla.org/docs/developer.html">Developers'
Guide</ulink>.
</para>
</note>
<para>
The syntax of the Template Toolkit language is beyond the scope of
this guide. It's reasonably easy to pick up by looking at the current
templates; or, you can read the manual, available on the
<ulink url="http://www.template-toolkit.org">Template Toolkit home
page</ulink>.
</para>
<para>
One thing you should take particular care about is the need
to properly HTML filter data that has been passed into the template.
This means that if the data can possibly contain special HTML characters
such as &lt;, and the data was not intended to be HTML, they need to be
converted to entity form, i.e. &amp;lt;. You use the 'html' filter in the
Template Toolkit to do this. If you forget, you may open up
your installation to cross-site scripting attacks.
</para>
<para>
Also note that Bugzilla adds a few filters of its own, that are not
in standard Template Toolkit. In particular, the 'url_quote' filter
can convert characters that are illegal or have special meaning in URLs,
such as &amp;, to the encoded form, i.e. %26. This actually encodes most
characters (but not the common ones such as letters and numbers and so
on), including the HTML-special characters, so there's never a need to
HTML filter afterwards.
</para>
<para>
Editing templates is a good way of doing a <quote>poor man's custom
fields</quote>.
For example, if you don't use the Status Whiteboard, but want to have
a free-form text entry box for <quote>Build Identifier</quote>,
then you can just
edit the templates to change the field labels. It's still be called
status_whiteboard internally, but your users don't need to know that.
</para>
</section>
<section id="template-formats">
<title>Template Formats and Types</title>
<para>
Some CGI's have the ability to use more than one template. For example,
<filename>buglist.cgi</filename> can output itself as RDF, or as two
formats of HTML (complex and simple). The mechanism that provides this
feature is extensible.
</para>
<para>
Bugzilla can support different types of output, which again can have
multiple formats. In order to request a certain type, you can append
the &amp;ctype=&lt;contenttype&gt; (such as rdf or html) to the
<filename>&lt;cginame&gt;.cgi</filename> URL. If you would like to
retrieve a certain format, you can use the &amp;format=&lt;format&gt;
(such as simple or complex) in the URL.
</para>
<para>
To see if a CGI supports multiple output formats and types, grep the
CGI for <quote>get_format</quote>. If it's not present, adding
multiple format/type support isn't too hard - see how it's done in
other CGIs, e.g. config.cgi.
</para>
<para>
To make a new format template for a CGI which supports this,
open a current template for
that CGI and take note of the INTERFACE comment (if present.) This
comment defines what variables are passed into this template. If
there isn't one, I'm afraid you'll have to read the template and
the code to find out what information you get.
</para>
<para>
Write your template in whatever markup or text style is appropriate.
</para>
<para>
You now need to decide what content type you want your template
served as. The content types are defined in the
<filename>Bugzilla/Constants.pm</filename> file in the
<filename>contenttypes</filename>
constant. If your content type is not there, add it. Remember
the three- or four-letter tag assigned to your content type.
This tag will be part of the template filename.
</para>
<note>
<para>
After adding or changing a content type, it's suitable to edit
<filename>Bugzilla/Constants.pm</filename> in order to reflect
the changes. Also, the file should be kept up to date after an
upgrade if content types have been customized in the past.
</para>
</note>
<para>
Save the template as <filename>&lt;stubname&gt;-&lt;formatname&gt;.&lt;contenttypetag&gt;.tmpl</filename>.
Try out the template by calling the CGI as
<filename>&lt;cginame&gt;.cgi?format=&lt;formatname&gt;&amp;ctype=&lt;type&gt;</filename> .
</para>
</section>
<section id="template-specific">
<title>Particular Templates</title>
<para>
There are a few templates you may be particularly interested in
customizing for your installation.
</para>
<para>
<command>index.html.tmpl</command>:
This is the Bugzilla front page.
</para>
<para>
<command>global/header.html.tmpl</command>:
This defines the header that goes on all Bugzilla pages.
The header includes the banner, which is what appears to users
and is probably what you want to edit instead. However the
header also includes the HTML HEAD section, so you could for
example add a stylesheet or META tag by editing the header.
</para>
<para>
<command>global/banner.html.tmpl</command>:
This contains the <quote>banner</quote>, the part of the header
that appears
at the top of all Bugzilla pages. The default banner is reasonably
barren, so you'll probably want to customize this to give your
installation a distinctive look and feel. It is recommended you
preserve the Bugzilla version number in some form so the version
you are running can be determined, and users know what docs to read.
</para>
<para>
<command>global/footer.html.tmpl</command>:
This defines the footer that goes on all Bugzilla pages. Editing
this is another way to quickly get a distinctive look and feel for
your Bugzilla installation.
</para>
<para>
<command>global/variables.none.tmpl</command>:
This defines a list of terms that may be changed in order to
<quote>brand</quote> the Bugzilla instance In this way, terms
like <quote>bugs</quote> can be replaced with <quote>issues</quote>
across the whole Bugzilla installation. The name
<quote>Bugzilla</quote> and other words can be customized as well.
</para>
<para>
<command>list/table.html.tmpl</command>:
This template controls the appearance of the bug lists created
by Bugzilla. Editing this template allows per-column control of
the width and title of a column, the maximum display length of
each entry, and the wrap behaviour of long entries.
For long bug lists, Bugzilla inserts a 'break' every 100 bugs by
default; this behaviour is also controlled by this template, and
that value can be modified here.
</para>
<para>
<command>bug/create/user-message.html.tmpl</command>:
This is a message that appears near the top of the bug reporting page.
By modifying this, you can tell your users how they should report
bugs.
</para>
<para>
<command>bug/process/midair.html.tmpl</command>:
This is the page used if two people submit simultaneous changes to the
same bug. The second person to submit their changes will get this page
to tell them what the first person did, and ask if they wish to
overwrite those changes or go back and revisit the bug. The default
title and header on this page read "Mid-air collision detected!" If
you work in the aviation industry, or other environment where this
might be found offensive (yes, we have true stories of this happening)
you'll want to change this to something more appropriate for your
environment.
</para>
<para>
<command>bug/create/create.html.tmpl</command> and
<command>bug/create/comment.txt.tmpl</command>:
You may not wish to go to the effort of creating custom fields in
Bugzilla, yet you want to make sure that each bug report contains
a number of pieces of important information for which there is not
a special field. The bug entry system has been designed in an
extensible fashion to enable you to add arbitrary HTML widgets,
such as drop-down lists or textboxes, to the bug entry page
and have their values appear formatted in the initial comment.
A hidden field that indicates the format should be added inside
the form in order to make the template functional. Its value should
be the suffix of the template filename. For example, if the file
is called <filename>create-cust.html.tmpl</filename>, then
<programlisting>&lt;input type="hidden" name="format" value="cust"&gt;</programlisting>
should be used inside the form.
</para>
<para>
An example of this is the mozilla.org
<ulink url="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi?product=WorldControl&amp;format=guided">guided
bug submission form</ulink>. The code for this comes with the Bugzilla
distribution as an example for you to copy. It can be found in the
files
<filename>create-guided.html.tmpl</filename> and
<filename>comment-guided.html.tmpl</filename>.
</para>
<para>
So to use this feature, create a custom template for
<filename>enter_bug.cgi</filename>. The default template, on which you
could base it, is
<filename>custom/bug/create/create.html.tmpl</filename>.
Call it <filename>create-&lt;formatname&gt;.html.tmpl</filename>, and
in it, add widgets for each piece of information you'd like
collected - such as a build number, or set of steps to reproduce.
</para>
<para>
Then, create a template like
<filename>custom/bug/create/comment.txt.tmpl</filename>, and call it
<filename>comment-&lt;formatname&gt;.txt.tmpl</filename>. This
template should reference the form fields you have created using
the syntax <filename>[% form.&lt;fieldname&gt; %]</filename>. When a
bug report is
submitted, the initial comment attached to the bug report will be
formatted according to the layout of this template.
</para>
<para>
For example, if your custom enter_bug template had a field
<programlisting>&lt;input type="text" name="buildid" size="30"&gt;</programlisting>
and then your comment.txt.tmpl had
<programlisting>BuildID: [% form.buildid %]</programlisting>
then something like
<programlisting>BuildID: 20020303</programlisting>
would appear in the initial comment.
</para>
</section>
<section id="template-http-accept">
<title>Configuring Bugzilla to Detect the User's Language</title>
<para>Bugzilla honours the user's Accept: HTTP header. You can install
templates in other languages, and Bugzilla will pick the most appropriate
according to a priority order defined by you. Many
language templates can be obtained from <ulink
url="http://www.bugzilla.org/download.html#localizations"/>. Instructions
for submitting new languages are also available from that location.
</para>
</section>
</section>
<section id="cust-hooks">
<title>The Bugzilla Extension Mechanism</title>
<warning>
<para>
Custom extensions require Template Toolkit version 2.12 or
above, or the application of a patch. See <ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=239112">bug
239112</ulink> for details.
</para>
</warning>
<para>
Extensions are a way for extensions to Bugzilla to insert code
into the standard Bugzilla templates and source files
without modifying these files themselves. The extension mechanism
defines a consistent API for extending the standard templates and source files
in a way that cleanly separates standard code from extension code.
Hooks reduce merge conflicts and make it easier to write extensions that work
across multiple versions of Bugzilla, making upgrading a Bugzilla installation
with installed extensions easier. Furthermore, they make it easy to install
and remove extensions as each extension is nothing more than a
simple directory structure.
</para>
<para>
There are two main types of hooks: code hooks and template hooks. Code
hooks allow extensions to invoke code at specific points in various
source files, while template hooks allow extensions to add elements to
the Bugzilla user interface.
</para>
<para>
A hook is just a named place in a standard source or template file
where extension source code or template files for that hook get processed.
Each extension has a corresponding directory in the Bugzilla directory
tree (<filename>BUGZILLA_ROOT/extensions/extension_name</filename>). Hooking
an extension source file or template to a hook is as simple as putting
the extension file into extension's template or code directory.
When Bugzilla processes the source file or template and reaches the hook,
it will process all extension files in the hook's directory.
The hooks themselves can be added into any source file or standard template
upon request by extension authors.
</para>
<para>
To use hooks to extend Bugzilla, first make sure there is
a hook at the appropriate place within the source file or template you
want to extend. The exact appearance of a hook depends on if the hook
is a code hook or a template hook.
</para>
<para>
Code hooks appear in Bugzilla source files as a single method call
in the format <literal role="code">Bugzilla::Hook->process("<varname>name</varname>");</literal>.
For instance, <filename>enter_bug.cgi</filename> may invoke the hook
"<varname>enter_bug-entrydefaultvars</varname>". Thus, a source file at
<filename>BUGZILLA_ROOT/extensions/EXTENSION_NAME/code/enter_bug-entrydefaultvars.pl</filename>
will be automatically invoked when the code hook is reached.
</para>
<para>
Template hooks appear in the standard Bugzilla templates as a
single directive in the format
<literal role="code">[% Hook.process("<varname>name</varname>") %]</literal>,
where <varname>name</varname> is the unique name of the hook.
</para>
<para>
If you aren't sure what you want to extend or just want to browse the
available hooks, either use your favorite multi-file search
tool (e.g. <command>grep</command>) to search the standard templates
for occurrences of <methodname>Hook.process</methodname> or the source
files for occurrences of <methodname>Bugzilla::Hook::process</methodname>.
</para>
<para>
If there is no hook at the appropriate place within the Bugzilla
source file or template you want to extend,
<ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=User%20Interface">file
a bug requesting one</ulink>, specifying:
</para>
<simplelist>
<member>the source or template file for which you are
requesting a hook;</member>
<member>
where in the file you would like the hook to be placed
(line number/position for latest version of the file in CVS
or description of location);
</member>
<member>the purpose of the hook;</member>
<member>a link to information about your extension, if any.</member>
</simplelist>
<para>
The Bugzilla reviewers will promptly review each hook request,
name the hook, add it to the template or source file, and check
the new version of the template into CVS.
</para>
<para>
You may optionally attach a patch to the bug which implements the hook
and check it in yourself after receiving approval from a Bugzilla
reviewer. The developers may suggest changes to the location of the
hook based on their analysis of your needs or so the hook can satisfy
the needs of multiple extensions, but the process of getting hooks
approved and checked in is not as stringent as the process for general
changes to Bugzilla, and any extension, whether released or still in
development, can have hooks added to meet their needs.
</para>
<para>
After making sure the hook you need exists (or getting it added if not),
add your extension to the directory within the Bugzilla
extensions tree corresponding to the hook.
</para>
<para>
That's it! Now, when the source file or template containing the hook
is processed, your extension file will be processed at the point
where the hook appears.
</para>
<para>
For example, let's say you have an extension named Projman that adds
project management capabilities to Bugzilla. Projman has an
administration interface <filename>edit-projects.cgi</filename>,
and you want to add a link to it into the navigation bar at the bottom
of every Bugzilla page for those users who are authorized
to administer projects.
</para>
<para>
The navigation bar is generated by the template file
<filename>useful-links.html.tmpl</filename>, which is located in
the <filename>global/</filename> subdirectory on the standard Bugzilla
template path
<filename>BUGZILLA_ROOT/template/en/default/</filename>.
Looking in <filename>useful-links.html.tmpl</filename>, you find
the following hook at the end of the list of standard Bugzilla
administration links:
</para>
<programlisting><![CDATA[...
[% ', <a href="editkeywords.cgi">keywords</a>'
IF user.groups.editkeywords %]
[% Hook.process("edit") %]
...]]></programlisting>
<para>
The corresponding extension file for this hook is
<filename>BUGZILLA_ROOT/extensions/projman/template/en/hook/global/useful-links-edit.html.tmpl</filename>.
You then create that template file and add the following constant:
</para>
<programlisting><![CDATA[...[% ', <a href="edit-projects.cgi">projects</a>' IF user.groups.projman_admins %]]]></programlisting>
<para>
Voila! The link now appears after the other administration links in the
navigation bar for users in the <literal>projman_admins</literal> group.
</para>
<para>
Now, let us say your extension adds a custom "project_manager" field
to enter_bug.cgi. You want to modify the CGI script to set the default
project manager to be productname@company.com. Looking at
<filename>enter_bug.cgi</filename>, you see the enter_bug-entrydefaultvars
hook near the bottom of the file before the default form values are set.
The corresponding extension source file for this hook is located at
<filename>BUGZILLA_ROOT/extensions/projman/code/enter_bug-entrydefaultvars.pl</filename>.
You then create that file and add the following:
</para>
<programlisting>$default{'project_manager'} = $product.'@company.com';</programlisting>
<para>
This code will be invoked whenever enter_bug.cgi is executed.
Assuming that the rest of the customization was completed (e.g. the
custom field was added to the enter_bug template and the required hooks
were used in process_bug.cgi), the new field will now have this
default value.
</para>
<para>
Notes:
</para>
<itemizedlist>
<listitem>
<para>
If your extension includes entirely new templates in addition to
extensions of standard templates, it should store those new
templates in its
<filename>BUGZILLA_ROOT/extensions/template/en/</filename>
directory. Extension template directories, like the
<filename>default/</filename> and <filename>custom/</filename>
directories, are part of the template search path, so putting templates
there enables them to be found by the template processor.
</para>
<para>
The template processor looks for templates first in the
<filename>custom/</filename> directory (i.e. templates added by the
specific installation), then in the <filename>extensions/</filename>
directory (i.e. templates added by extensions), and finally in the
<filename>default/</filename> directory (i.e. the standard Bugzilla
templates). Thus, installation-specific templates override both
default and extension templates.
</para>
</listitem>
<listitem>
<para>
If you are looking to customize Bugzilla, you can also take advantage
of template hooks. To do so, create a directory in
<filename>BUGZILLA_ROOT/template/en/custom/hook/</filename>
that corresponds to the hook you wish to use, then place your
customization templates into those directories. For example,
if you wanted to use the hook "end" in
<filename>global/useful-links.html.tmpl</filename>, you would
create the directory <filename>BUGZILLA_ROOT/template/en/custom/hook/
global/useful-links.html.tmpl/end/</filename> and add your customization
template to this directory.
</para>
<para>
Obviously this method of customizing Bugzilla only lets you add code
to the standard source files and templates; you cannot change the
existing code. Nevertheless, for those customizations that only add
code, this method can reduce conflicts when merging changes,
making upgrading your customized Bugzilla installation easier.
</para>
</listitem>
</itemizedlist>
</section>
<section id="cust-change-permissions">
<title>Customizing Who Can Change What</title>
<warning>
<para>
This feature should be considered experimental; the Bugzilla code you
will be changing is not stable, and could change or move between
versions. Be aware that if you make modifications as outlined here,
you may have
to re-make them or port them if Bugzilla changes internally between
versions, and you upgrade.
</para>
</warning>
<para>
Companies often have rules about which employees, or classes of employees,
are allowed to change certain things in the bug system. For example,
only the bug's designated QA Contact may be allowed to VERIFY the bug.
Bugzilla has been
designed to make it easy for you to write your own custom rules to define
who is allowed to make what sorts of value transition.
</para>
<para>
By default, assignees, QA owners and users
with <emphasis>editbugs</emphasis> privileges can edit all fields of bugs,
except group restrictions (unless they are members of the groups they
are trying to change). Bug reporters also have the ability to edit some
fields, but in a more restrictive manner. Other users, without
<emphasis>editbugs</emphasis> privileges, can not edit
bugs, except to comment and add themselves to the CC list.
</para>
<para>
For maximum flexibility, customizing this means editing Bugzilla's Perl
code. This gives the administrator complete control over exactly who is
allowed to do what. The relevant method is called
<filename>check_can_change_field()</filename>,
and is found in <filename>Bug.pm</filename> in your
Bugzilla/ directory. If you open that file and search for
<quote>sub check_can_change_field</quote>, you'll find it.
</para>
<para>
This function has been carefully commented to allow you to see exactly
how it works, and give you an idea of how to make changes to it.
Certain marked sections should not be changed - these are
the <quote>plumbing</quote> which makes the rest of the function work.
In between those sections, you'll find snippets of code like:
<programlisting> # Allow the assignee to change anything.
if ($ownerid eq $whoid) {
return 1;
}</programlisting>
It's fairly obvious what this piece of code does.
</para>
<para>
So, how does one go about changing this function? Well, simple changes
can be made just by removing pieces - for example, if you wanted to
prevent any user adding a comment to a bug, just remove the lines marked
<quote>Allow anyone to change comments.</quote> If you don't want the
Reporter to have any special rights on bugs they have filed, just
remove the entire section that deals with the Reporter.
</para>
<para>
More complex customizations are not much harder. Basically, you add
a check in the right place in the function, i.e. after all the variables
you are using have been set up. So, don't look at $ownerid before
$ownerid has been obtained from the database. You can either add a
positive check, which returns 1 (allow) if certain conditions are true,
or a negative check, which returns 0 (deny.) E.g.:
<programlisting> if ($field eq "qacontact") {
if (Bugzilla->user->groups("quality_assurance")) {
return 1;
}
else {
return 0;
}
}</programlisting>
This says that only users in the group "quality_assurance" can change
the QA Contact field of a bug.
</para>
<para>
Getting more weird:
<programlisting><![CDATA[ if (($field eq "priority") &&
(Bugzilla->user->email =~ /.*\@example\.com$/))
{
if ($oldvalue eq "P1") {
return 1;
}
else {
return 0;
}
}]]></programlisting>
This says that if the user is trying to change the priority field,
and their email address is @example.com, they can only do so if the
old value of the field was "P1". Not very useful, but illustrative.
</para>
<warning>
<para>
If you are modifying <filename>process_bug.cgi</filename> in any
way, do not change the code that is bounded by DO_NOT_CHANGE blocks.
Doing so could compromise security, or cause your installation to
stop working entirely.
</para>
</warning>
<para>
For a list of possible field names, look at the bugs table in the
database. If you need help writing custom rules for your organization,
ask in the newsgroup.
</para>
</section>
<!-- Integrating Bugzilla with Third-Party Tools -->
&integration;
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="faq">
<title>The Bugzilla FAQ</title>
<para>
This FAQ includes questions not covered elsewhere in the Guide.
</para>
<qandaset>
<qandadiv id="faq-general">
<title>General Questions</title>
<qandaentry>
<question id="faq-general-tryout">
<para>
Can I try out Bugzilla somewhere?
</para>
</question>
<answer>
<para>
If you want to take a test ride, there are test installations
at <ulink url="http://landfill.bugzilla.org/"/>,
ready to play with directly from your browser.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-license">
<para>
What license is Bugzilla distributed under?
</para>
</question>
<answer>
<para>
Bugzilla is covered by the Mozilla Public License.
See details at <ulink url="http://www.mozilla.org/MPL/"/>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-support">
<para>
How do I get commercial support for Bugzilla?
</para>
</question>
<answer>
<para>
<ulink url="http://www.bugzilla.org/support/consulting.html"/>
is a list of companies and individuals who have asked us to
list them as consultants for Bugzilla.
</para>
<para>
There are several experienced
Bugzilla hackers on the mailing list/newsgroup who are willing
to make themselves available for generous compensation.
Try sending a message to the mailing list asking for a volunteer.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-companies">
<para>
What major companies or projects are currently using Bugzilla
for bug-tracking?
</para>
</question>
<answer>
<para>
There are <emphasis>dozens</emphasis> of major companies with public
Bugzilla sites to track bugs in their products. We have a fairly
complete list available on our website at
<ulink url="http://bugzilla.org/installation-list/"/>. If you
have an installation of Bugzilla and would like to be added to the
list, whether it's a public install or not, simply e-mail
Gerv <email>gerv@mozilla.org</email>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-maintainers">
<para>
Who maintains Bugzilla?
</para>
</question>
<answer>
<para>
A <ulink url="http://www.bugzilla.org/developers/profiles.html">core
team</ulink>, led by Dave Miller (justdave@bugzilla.org).
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-compare">
<para>
How does Bugzilla stack up against other bug-tracking databases?
</para>
</question>
<answer>
<para>
We can't find any head-to-head comparisons of Bugzilla against
other defect-tracking software. If you know of one, please get
in touch. In the experience of Matthew Barnson (the original
author of this FAQ), though, Bugzilla offers superior
performance on commodity hardware, better price (free!), more
developer-friendly features (such as stored queries, email
integration, and platform independence), improved scalability,
greater flexibility, and superior ease-of-use when compared
to commercial bug-tracking software.
</para>
<para>
If you happen to be a vendor for commercial bug-tracking
software, and would like to submit a list of advantages your
product has over Bugzilla, simply send it to
<email>documentation@bugzilla.org</email> and we'd be happy to
include the comparison in our documentation.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-bzmissing">
<para>
Why doesn't Bugzilla offer this or that feature or compatibility
with this other tracking software?
</para>
</question>
<answer>
<para>
It may be that the support has not been built yet, or that you
have not yet found it. While Bugzilla makes strides in usability,
customizability, scalability, and user interface with each release,
that doesn't mean it can't still use improvement!
</para>
<para>
The best way to make an enhancement request is to <ulink
url="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">file
a bug at bugzilla.mozilla.org</ulink> and set the Severity
to 'enhancement'. Your 'request for enhancement' (RFE) will
start out in the UNCONFIRMED state, and will stay there until
someone with the ability to CONFIRM the bug reviews it.
If that person feels it to be a good request that fits in with
Bugzilla's overall direction, the status will be changed to
NEW; if not, they will probably explain why and set the bug
to RESOLVED/WONTFIX. If someone else has made the same (or
almost the same) request before, your request will be marked
RESOLVED/DUPLICATE, and a pointer to the previous RFE will be
added.
</para>
<para>
Even if your RFE gets approved, that doesn't mean it's going
to make it right into the next release; there are a limited
number of developers, and a whole lot of RFEs... some of
which are <emphasis>quite</emphasis> complex. If you're a
code-hacking sort of person, you can help the project along
by making a patch yourself that supports the functionality
you require. If you have never contributed anything to
Bugzilla before, please be sure to read the
<ulink url="http://www.bugzilla.org/docs/developer.html">Developers' Guide</ulink>
and
<ulink url="http://www.bugzilla.org/docs/contributor.html">Contributors' Guide</ulink>
before going ahead.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-db">
<para>
What databases does Bugzilla run on?
</para>
</question>
<answer>
<para>
MySQL is the default database for Bugzilla. It was originally chosen
because it is free, easy to install, and was available for the hardware
Netscape intended to run it on.
</para>
<para>
As of Bugzilla 2.22, complete support for PostgreSQL
is included. With this release using PostgreSQL with Bugzilla
should be as stable as using MySQL. If you experience any problems
with PostgreSQL compatibility, they will be taken as
seriously as if you were running MySQL.
</para>
<para>
There are plans to include an Oracle driver for Bugzilla 3.1.2.
Track progress at
<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=189947">
Bug 189947</ulink>.
</para>
<para>
Sybase support was worked on for a time. However, several
complicating factors have prevented Sybase support from
being realized. There are currently no plans to revive it.
</para>
<para>
<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=237862">
Bug 237862</ulink> is a good bug to read through if you'd
like to see what progress is being made on general database
compatibility.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-perlpath">
<para>
My perl is located at <filename>/usr/local/bin/perl</filename>
and not <filename>/usr/bin/perl</filename>. Is there an easy
to change that in all the files that have this hard-coded?
</para>
</question>
<answer>
<para>
The easiest way to get around this is to create a link from
one to the other:
<command>ln -s /usr/local/bin/perl /usr/bin/perl</command>.
If that's not an option for you, the following bit of perl
magic will change all the shebang lines (that is to say,
the line at the top of each file that starts with '#!'
and contains the path) to something else:
</para>
<programlisting>
perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl
</programlisting>
<para>
Sadly, this command-line won't work on Windows unless you
also have Cygwin. However, MySQL comes with a binary called
<command>replace</command> which can do the job:
</para>
<programlisting>
C:\mysql\bin\replace "#!/usr/bin/perl" "#!C:\perl\bin\perl" -- *.cgi *.pl
</programlisting>
<note>
<para>
If your perl path is something else again, just follow the
above examples and replace
<filename>/usr/local/bin/perl</filename> with your own perl path.
</para>
</note>
<para>
Once you've modified all your files, you'll also need to modify the
<filename>t/002goodperl.t</filename> test, as it tests that all
shebang lines are equal to <filename>/usr/bin/perl</filename>.
(For more information on the test suite, please check out the
appropriate section in the <ulink
url="http://www.bugzilla.org/docs/developer.html#testsuite">Developers'
Guide</ulink>.) Having done this, run the test itself:
<programlisting>
perl runtests.pl 2 --verbose
</programlisting>
to ensure that you've modified all the relevant files.
</para>
<para>
If using Apache on Windows, you can avoid the whole problem
by setting the <ulink
url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">
ScriptInterpreterSource</ulink> directive to 'Registry'.
(If using Apache 2 or higher, set it to 'Registry-Strict'.)
ScriptInterperterSource requires a registry entry
<quote>HKEY_CLASSES_ROOT\.cgi\Shell\ExecCGI\Command</quote> to
associate .cgi files with your perl executable. If one does
not already exist, create it with a default value of
<quote>&lt;full path to perl&gt; -T</quote>, e.g.
<quote>C:\Perl\bin\perl.exe -T</quote>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-cookie">
<para>
Is there an easy way to change the Bugzilla cookie name?
</para>
</question>
<answer>
<para>
At present, no.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-general-selinux">
<para>
How can Bugzilla be made to work under SELinux?
</para>
</question>
<answer>
<para>
As a web application, Bugzilla simply requires its root
directory to have the httpd context applied for it to work
properly under SELinux. This should happen automatically
on distributions that use SELinux and that package Bugzilla
(if it is installed with the native package management tools).
Information on how to view and change SELinux file contexts
can be found at the
<ulink url="http://docs.fedoraproject.org/selinux-faq-fc5/">
SELinux FAQ</ulink>.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-phb">
<title>Managerial Questions</title>
<qandaentry>
<question id="faq-phb-client">
<para>
Is Bugzilla web-based, or do you have to have specific software or
a specific operating system on your machine?
</para>
</question>
<answer>
<para>
It is web and e-mail based.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-priorities">
<para>
Does Bugzilla allow us to define our own priorities and levels?
Do we have complete freedom to change the labels of fields and
format of them, and the choice of acceptable values?
</para>
</question>
<answer>
<para>
Yes. However, modifying some fields, notably those related to bug
progression states, also require adjusting the program logic to
compensate for the change.
</para>
<para>
As of Bugzilla 3.0 custom fields can be created via the
"Custom Fields" admin page.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-reporting">
<para>
Does Bugzilla provide any reporting features, metrics, graphs,
etc? You know, the type of stuff that management likes to see. :)
</para>
</question>
<answer>
<para>
Yes. Look at <ulink url="https://bugzilla.mozilla.org/report.cgi"/>
for samples of what Bugzilla can do in reporting and graphing.
Fuller documentation is provided in <xref linkend="reporting"/>.
</para>
<para>
If you can not get the reports you want from the included reporting
scripts, it is possible to hook up a professional reporting package
such as Crystal Reports using ODBC. If you choose to do this,
beware that giving direct access to the database does contain some
security implications. Even if you give read-only access to the
bugs database it will bypass the secure bugs features of Bugzilla.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-email">
<para>
Is there email notification? If so, what do you see
when you get an email?
</para>
</question>
<answer>
<para>
Email notification is user-configurable. By default, the bug id
and summary of the bug report accompany each email notification,
along with a list of the changes made.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-emailapp">
<para>
Do users have to have any particular type of email application?
</para>
</question>
<answer>
<para>
Bugzilla email is sent in plain text, the most compatible
mail format on the planet.
<note>
<para>
If you decide to use the bugzilla_email integration features
to allow Bugzilla to record responses to mail with the
associated bug, you may need to caution your users to set
their mailer to <quote>respond to messages in the format in
which they were sent</quote>. For security reasons Bugzilla
ignores HTML tags in comments, and if a user sends HTML-based
email into Bugzilla the resulting comment looks downright awful.
</para>
</note>
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-data">
<para>
Does Bugzilla allow data to be imported and exported? If I had
outsiders write up a bug report using a MS Word bug template,
could that template be imported into <quote>matching</quote>
fields? If I wanted to take the results of a query and export
that data to MS Excel, could I do that?
</para>
</question>
<answer>
<para>
Bugzilla can output buglists as HTML (the default), CSV or RDF.
The link for CSV can be found at the bottom of the buglist in HTML
format. This CSV format can easily be imported into MS Excel or
other spreadsheet applications.
</para>
<para>
To use the RDF format of the buglist it is necessary to append a
<computeroutput>&amp;ctype=rdf</computeroutput> to the URL. RDF
is meant to be machine readable and thus it is assumed that the
URL would be generated programmatically so there is no user visible
link to this format.
</para>
<para>
Currently the only script included with Bugzilla that can import
data is <filename>importxml.pl</filename> which is intended to be
used for importing the data generated by the XML ctype of
<filename>show_bug.cgi</filename> in association with bug moving.
Any other use is left as an exercise for the user.
</para>
<para>
There are also scripts included in the <filename>contrib/</filename>
directory for using e-mail to import information into Bugzilla,
but these scripts are not currently supported and included for
educational purposes.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-l10n">
<para>
Has anyone converted Bugzilla to another language to be
used in other countries? Is it localizable?
</para>
</question>
<answer>
<para>
Yes. For more information including available translated templates,
see <ulink
url="http://www.bugzilla.org/download.html#localizations"/>.
Some admin interfaces have been templatized (for easy localization)
but many of them are still available in English only. Also, there
may be issues with the charset not being declared. See <ulink
url="https://bugzilla.mozilla.org/show_bug.cgi?id=126266">bug 126226</ulink>
for more information.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-reports">
<para>
Can a user create and save reports?
Can they do this in Word format? Excel format?
</para>
</question>
<answer>
<para>
Yes. No. Yes (using the CSV format).
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-backup">
<para>
Are there any backup features provided?
</para>
</question>
<answer>
<para>
You should use the backup options supplied by your database platform.
Vendor documentation for backing up a MySQL database can be found at
<ulink url="http://www.mysql.com/doc/B/a/Backup.html"/>.
PostgreSQL backup documentation can be found at
<ulink url="http://www.postgresql.org/docs/8.0/static/backup.html"/>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-maintenance">
<para>
What type of human resources are needed to be on staff to install
and maintain Bugzilla? Specifically, what type of skills does the
person need to have? I need to find out what types of individuals
would we need to hire and how much would that cost if we were to
go with Bugzilla vs. buying an <quote>out-of-the-box</quote>
solution.
</para>
</question>
<answer>
<para>
If Bugzilla is set up correctly from the start, continuing
maintenance needs are minimal and can be done easily using
the web interface.
</para>
<para>
Commercial Bug-tracking software typically costs somewhere
upwards of $20,000 or more for 5-10 floating licenses. Bugzilla
consultation is available from skilled members of the newsgroup.
Simple questions are answered there and then.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-installtime">
<para>
What time frame are we looking at if we decide to hire people
to install and maintain the Bugzilla? Is this something that
takes hours or days to install and a couple of hours per week
to maintain and customize, or is this a multi-week install process,
plus a full time job for 1 person, 2 people, etc?
</para>
</question>
<answer>
<para>
It all depends on your level of commitment. Someone with much
Bugzilla experience can get you up and running in less than a day,
and your Bugzilla install can run untended for years. If your
Bugzilla strategy is critical to your business workflow, hire
somebody to who has reasonable Perl skills, and a familiarity
with the operating system on which Bugzilla will be running,
and have them handle your process management, bug-tracking
maintenance, and local customization.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-cost">
<para>
Is there any licensing fee or other fees for using Bugzilla? Any
out-of-pocket cost other than the bodies needed as identified above?
</para>
</question>
<answer>
<para>
No. Bugzilla, Perl, the Template Toolkit, and all other support
software needed to make Bugzilla work can be downloaded for free.
MySQL and PostgreSQL -- the databases supported by Bugzilla --
are also open-source. MySQL asks that if you find their product
valuable, you purchase a support contract from them that suits your needs.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-phb-renameBugs">
<para>
We don't like referring to problems as 'bugs'. Can we change that?
</para>
</question>
<answer>
<para>
Yes! As of Bugzilla 2.18, it is a simple matter to change the
word 'bug' into whatever word/phrase is used by your organization.
See the documentation on Customization for more details,
specifically <xref linkend="template-specific"/>.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-admin">
<title>Administrative Questions</title>
<qandaentry>
<question id="faq-admin-midair">
<para>
Does Bugzilla provide record locking when there is simultaneous
access to the same bug? Does the second person get a notice
that the bug is in use or how are they notified?
</para>
</question>
<answer>
<para>
Bugzilla does not lock records. It provides mid-air collision
detection -- which means that it warns a user when a commit is
about to conflict with commits recently made by another user,
and offers the second user a choice of options to deal with
the conflict.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-admin-livebackup">
<para>
Can users be on the system while a backup is in progress?
</para>
</question>
<answer>
<para>
Refer to your database platform documentation for details on how to do hot
backups.
Vendor documentation for backing up a MySQL database can be found at
<ulink url="http://www.mysql.com/doc/B/a/Backup.html"/>.
PostgreSQL backup documentation can be found at
<ulink url="http://www.postgresql.org/docs/8.0/static/backup.html"/>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-admin-cvsupdate">
<para>
How can I update the code and the database using CVS?
</para>
</question>
<answer>
<para>
<orderedlist>
<listitem>
<para>
Make a backup of both your Bugzilla directory and the
database. For the Bugzilla directory this is as easy as
doing <command>cp -rp bugzilla bugzilla.bak</command>.
For the database, there's a number of options - see the
MySQL docs and pick the one that fits you best (the easiest
is to just make a physical copy of the database on the disk,
but you have to have the database server shut down to do
that without risking dataloss).
</para>
</listitem>
<listitem>
<para>
Make the Bugzilla directory your current directory.
</para>
</listitem>
<listitem>
<para>
Use <command>cvs -q update -AdP</command> if you want to
update to the tip or
<command>cvs -q update -dP -rTAGNAME</command>
if you want a specific version (in that case you'll have to
replace TAGNAME with a CVS tag name such as BUGZILLA-2_16_5).
</para>
<para>
If you've made no local changes, this should be very clean.
If you have made local changes, then watch the cvs output
for C results. If you get any lines that start with a C
it means there were conflicts between your local changes
and what's in CVS. You'll need to fix those manually before
continuing.
</para>
</listitem>
<listitem>
<para>
After resolving any conflicts that the cvs update operation
generated, running <command>./checksetup.pl</command> will
take care of updating the database for you as well as any
other changes required for the new version to operate.
</para>
<warning>
<para>
Once you run checksetup.pl, the only way to go back is
to restore the database backups. You can't
<quote>downgrade</quote> the system cleanly under most
circumstances.
</para>
</warning>
</listitem>
</orderedlist>
</para>
<para>
See also the instructions in <xref linkend="upgrade-cvs"/>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-admin-enable-unconfirmed">
<para>
How do I make it so that bugs can have an UNCONFIRMED status?
</para>
</question>
<answer>
<para>
To use the UNCONFIRMED status, you must have the 'usevotes'
parameter set to <quote>On</quote>. You must then visit the
<filename>editproducts.cgi</filename> page and set the <quote>
Number of votes a bug in this product needs to automatically
get out of the UNCONFIRMED state</quote> to be a non-zero number.
(You will have to do this for each product that wants to use
the UNCONFIRMED state.) If you do not actually want users to be
able to vote for bugs entered against this product, leave the
<quote>Maximum votes per person</quote> value at '0'.
</para>
<para>
There is work being done to decouple the UNCONFIRMED state from
the 'usevotes' parameter for future versions of Bugzilla.
Follow the discussion and progress at <ulink
url="https://bugzilla.mozilla.org/show_bug.cgi?id=162060">bug
162060</ulink>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-admin-moving">
<para>
How do I move a Bugzilla installation from one machine to another?
</para>
</question>
<answer>
<para>
Reference your database vendor's documentation for information on
backing up and restoring your Bugzilla database on to a different server.
Vendor documentation for backing up a MySQL database can be found at
<ulink url="http://dev.mysql.com/doc/mysql/en/mysqldump.html"/>.
PostgreSQL backup documentation can be found at
<ulink url="http://www.postgresql.org/docs/8.0/static/backup.html"/>.
</para>
<para>
On your new machine, follow the instructions found in <xref
linkend="installing-bugzilla"/> as far as setting up the physical
environment of the new machine with perl, webserver, modules, etc.
Having done that, you can either: copy your entire Bugzilla
directory from the old machine to a new one (if you want to keep
your existing code and modifications), or download a newer version
(if you are planning to upgrade at the same time). Even if you are
upgrading to clean code, you will still want to bring over the
<filename>localconfig</filename> file, and the
<filename class="directory">data</filename> directory from the
old machine, as they contain configuration information that you
probably won't want to re-create.
</para>
<note>
<para>
If the hostname or port number of your database server changed
as part of the move, you'll need to update the appropriate
variables in localconfig before taking the next step.
</para>
</note>
<para>
Once you have your code in place, and your database has
been restored from the backup you made in step 1, run
<command>checksetup.pl</command>. This will upgrade your
database (if necessary), rebuild your templates, etc.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-admin-makeadmin">
<para>
How do I make a new Bugzilla administrator?
The previous administrator is gone...
</para>
</question>
<answer>
<para>
Run <command>checksetup.pl</command> with
<option>--make-admin</option> option.
Its usage is <option>--make-admin=user@example.org</option>.
The user account must be exist in the Bugzilla database.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-security">
<title>Bugzilla Security</title>
<qandaentry>
<question id="faq-security-mysql">
<para>
How do I completely disable MySQL security if it's giving
me problems? (I've followed the instructions in the installation
section of this guide...)
</para>
</question>
<answer>
<para>
You can run MySQL like this: <command>mysqld --skip-grant-tables</command>.
However, doing so disables all MySQL security. This is a bad idea.
Please consult <xref linkend="security-mysql"/> of this guide
and the MySQL documentation for better solutions.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-security-knownproblems">
<para>
Are there any security problems with Bugzilla?
</para>
</question>
<answer>
<para>
The Bugzilla code has undergone a reasonably complete security
audit, and user-facing CGIs run under Perl's taint mode. However,
it is recommended that you closely examine permissions on your
Bugzilla installation, and follow the recommended security
guidelines found in The Bugzilla Guide.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-email">
<title>Bugzilla Email</title>
<qandaentry>
<question id="faq-email-nomail">
<para>
I have a user who doesn't want to receive any more email
from Bugzilla. How do I stop it entirely for this user?
</para>
</question>
<answer>
<para>
The user can stop Bugzilla from sending any mail by unchecking
all boxes on the 'Edit prefs' -> 'Email settings' page.
(As of 2.18,this is made easier by the addition of a 'Disable
All Mail' button.) Alternately, you can add their email address
to the <filename>data/nomail</filename> file (one email address
per line). This will override their personal preferences, and
they will never be sent mail again.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-email-testing">
<para>
I'm evaluating/testing Bugzilla, and don't want it to send email
to anyone but me. How do I do it?
</para>
</question>
<answer>
<para>
To disable email, set the
<option>mail_delivery_method</option> parameter to
<literal>none</literal> (2.20 and later), or
<programlisting>$enableSendMail</programlisting> parameter to '0'
in either <filename>BugMail.pm</filename> (2.18 and later) or
<filename>processmail</filename> (up to 2.16.x).
</para>
<note>
<para>
Up to 2.16.x, changing
<programlisting>$enableSendMail</programlisting>
will only affect bugmail; email related to password changes,
email address changes, bug imports, flag changes, etc. will
still be sent out. As of the final release of 2.18, however,
the above step will disable <emphasis>all</emphasis> mail
sent from Bugzilla for any purpose.
</para>
</note>
<para>
To have bugmail (and only bugmail) redirected to you instead of
its intended recipients, leave
<programlisting>$enableSendMail</programlisting> alone;
instead, edit the <quote>newchangedmail</quote> parameter
as follows:
</para>
<itemizedlist>
<listitem>
<para>
Replace <quote>To:</quote> with <quote>X-Real-To:</quote>
</para>
</listitem>
<listitem>
<para>
Replace <quote>Cc:</quote> with <quote>X-Real-CC:</quote>
</para>
</listitem>
<listitem>
<para>
Add a <quote>To: %lt;your_email_address&gt;</quote>
</para>
</listitem>
</itemizedlist>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-email-whine">
<para>
I want whineatnews.pl to whine at something other than new and
reopened bugs. How do I do it?
</para>
</question>
<answer>
<para>
For older versions of Bugzilla, you may be able to apply
Klaas Freitag's patch for <quote>whineatassigned</quote>,
which can be found in
<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=6679">bug
6679</ulink>. Note that this patch was made in 2000, so it may take
some work to apply cleanly to any releases of Bugzilla newer than
that, but you can use it as a starting point.
</para>
<para>
An updated (and much-expanded) version of this functionality is
due to be released as part of Bugzilla 2.20; see
<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=185090">bug
185090</ulink> for the discussion, and for more up-to-date patches
if you just can't wait.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-email-in">
<para>
How do I set up the email interface to submit or change bugs via email?
</para>
</question>
<answer>
<para>
Bugzilla 3.0 and later offers the ability submit or change
bugs via email, using the <filename>email_in.pl</filename>
script within the root directory of the Bugzilla installation.
More information on the script can be found in
<ulink url="api/email_in.html">docs/html/api/email_in.html</ulink>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-email-sendmailnow">
<para>
Email takes FOREVER to reach me from Bugzilla -- it's
extremely slow. What gives?
</para>
</question>
<answer>
<para>
If you are using <application>sendmail</application>, try
enabling <option>sendmailnow</option> in
<filename>editparams.cgi</filename>. For earlier versions of
<application>sendmail</application>, one could achieve
significant performance improvement in the UI (at the cost of
delaying the sending of mail) by setting this parameter to
<literal>off</literal>. Sites with
<application>sendmail</application> version 8.12 (or higher)
should leave this <literal>on</literal>, as they will not see
any performance benefit.
</para>
<para>
If you are using an alternate
<glossterm linkend="gloss-mta">MTA</glossterm>, make sure the
options given in <filename>Bugzilla/BugMail.pm</filename>
and any other place where <application>sendmail</application>
is called are correct for your MTA.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-email-nonreceived">
<para>
How come email from Bugzilla changes never reaches me?
</para>
</question>
<answer>
<para>
Double-check that you have not turned off email in your user
preferences. Confirm that Bugzilla is able to send email by
visiting the <quote>Log In</quote> link of your Bugzilla
installation and clicking the <quote>Submit Request</quote>
button after entering your email address.
</para>
<para>
If you never receive mail from Bugzilla, chances are you do
not have sendmail in "/usr/lib/sendmail". Ensure sendmail
lives in, or is symlinked to, "/usr/lib/sendmail".
</para>
<para>
If you are using an MTA other than
<application>sendmail</application> the
<option>sendmailnow</option> param must be set to
<literal>on</literal> or no mail will be sent.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-db">
<title>Bugzilla Database</title>
<qandaentry>
<question id="faq-db-corrupted">
<para>
I think my database might be corrupted, or contain
invalid entries. What do I do?
</para>
</question>
<answer>
<para>
Run the <quote>sanity check</quote> utility
(<filename>sanitycheck.cgi</filename>) from your web browser
to see! If it finishes without errors, you're
<emphasis>probably</emphasis> OK. If it doesn't come back
OK (i.e. any red letters), there are certain things
Bugzilla can recover from and certain things it can't. If
it can't auto-recover, I hope you're familiar with
mysqladmin commands or have installed another way to
manage your database. Sanity Check, although it is a good
basic check on your database integrity, by no means is a
substitute for competent database administration and
avoiding deletion of data. It is not exhaustive, and was
created to do a basic check for the most common problems
in Bugzilla databases.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-db-manualedit">
<para>
I want to manually edit some entries in my database. How?
</para>
</question>
<answer>
<para>
There is no facility in Bugzilla itself to do this. It's also
generally not a smart thing to do if you don't know exactly what
you're doing. If you understand SQL, though, you can use the
<command>mysql</command> or <command>psql</command> command line
utilities to manually insert, delete and modify table information.
There are also more intuitive GUI clients available for both MySQL
and PostgreSQL. For MySQL, we recommend
<ulink url="http://www.phpmyadmin.net/">phpMyAdmin</ulink>.
</para>
<para>
Remember, backups are your friend. Everyone makes mistakes, and
it's nice to have a safety net in case you mess something up.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-db-permissions">
<para>
I think I've set up MySQL permissions correctly, but Bugzilla still
can't connect.
</para>
</question>
<answer>
<para>
Try running MySQL from its binary:
<command>mysqld --skip-grant-tables</command>.
This will allow you to completely rule out grant tables as the
cause of your frustration. If this Bugzilla is able to connect
at this point then you need to check that you have granted proper
permission to the user password combo defined in
<filename>localconfig</filename>.
</para>
<warning>
<para>
Running MySQL with this command line option is very insecure and
should only be done when not connected to the external network
as a troubleshooting step. Please do not run your production
database in this mode.
</para>
</warning>
<para>
You may also be suffering from a client version mismatch:
</para>
<para>
MySQL 4.1 and up uses an authentication protocol based on
a password hashing algorithm that is incompatible with that
used by older clients. If you upgrade the server to 4.1,
attempts to connect to it with an older client may fail
with the following message:
</para>
<para>
<screen><prompt>shell&gt;</prompt> mysql
Client does not support authentication protocol requested
by server; consider upgrading MySQL client
</screen>
</para>
<para>
To solve this problem, you should use one of the following
approaches:
</para>
<para>
<itemizedlist>
<listitem>
<para>
Upgrade all client programs to use a 4.1.1 or newer
client library.
</para>
</listitem>
<listitem>
<para>
When connecting to the server with a pre-4.1 client
program, use an account that still has a
pre-4.1-style password.
</para>
</listitem>
<listitem>
<para>
Reset the password to pre-4.1 style for each user
that needs to use a pre-4.1 client program.
This can be done using the SET PASSWORD statement
and the OLD_PASSWORD() function:
<screen>
<prompt>mysql&gt;</prompt> SET PASSWORD FOR
<prompt> -&gt;</prompt> ' some_user '@' some_host ' = OLD_PASSWORD(' newpwd ');
</screen>
</para>
</listitem>
</itemizedlist>
</para>
<para>
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-db-synchronize">
<para>
How do I synchronize bug information among multiple
different Bugzilla databases?
</para>
</question>
<answer>
<para>
Well, you can synchronize or you can move bugs.
Synchronization will only work one way -- you can create
a read-only copy of the database at one site, and have it
regularly updated at intervals from the main database.
</para>
<para>
MySQL has some synchronization features built-in to the
latest releases. It would be great if someone looked into
the possibilities there and provided a report to the
newsgroup on how to effectively synchronize two Bugzilla
installations.
</para>
<para>
If you simply need to transfer bugs from one Bugzilla to another,
checkout the <quote>move.pl</quote> script in the Bugzilla
distribution.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-nt">
<title>Can Bugzilla run on a Windows server?</title>
<qandaentry>
<question id="faq-nt-easiest">
<para>
What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
</para>
</question>
<answer>
<para>
Making Bugzilla work easily with Windows
was one of the major goals of the 2.18 milestone. If the
necessary components are in place (perl, a webserver, an MTA, etc.)
then installation of Bugzilla on a Windows box should be no more
difficult than on any other platform. As with any installation,
we recommend that you carefully and completely follow the
installation instructions in <xref linkend="os-win32"/>.
</para>
<para>
While doing so, don't forget to check out the very excellent guide
to <ulink url="http://www.bugzilla.org/docs/win32install.html">
Installing Bugzilla on Microsoft Windows</ulink> written by
Byron Jones. Thanks, Byron!
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-nt-bundle">
<para>
Is there a "Bundle::Bugzilla" equivalent for Win32?
</para>
</question>
<answer>
<para>
Not currently. Bundle::Bugzilla enormously simplifies Bugzilla
installation on UNIX systems. If someone can volunteer to
create a suitable PPM bundle for Win32, it would be appreciated.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-nt-mappings">
<para>
CGI's are failing with a <quote>something.cgi is not a valid
Windows NT application</quote> error. Why?
</para>
</question>
<answer>
<para>
Depending on what Web server you are using, you will have to
configure the Web server to treat *.cgi files as CGI scripts.
In IIS, you do this by adding *.cgi to the App Mappings with
the &lt;path&gt;\perl.exe %s %s as the executable.
</para>
<para>
Microsoft has some advice on this matter, as well:
<blockquote>
<para>
<quote>Set application mappings. In the ISM, map the extension
for the script file(s) to the executable for the script
interpreter. For example, you might map the extension .py to
Python.exe, the executable for the Python script interpreter.
Note For the ActiveState Perl script interpreter, the extension
'.pl' is associated with PerlIS.dll by default. If you want
to change the association of .pl to perl.exe, you need to
change the application mapping. In the mapping, you must add
two percent (%) characters to the end of the pathname for
perl.exe, as shown in this example:
<command>c:\perl\bin\perl.exe %s %s</command></quote>
</para>
</blockquote>
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-nt-dbi">
<para>
I'm having trouble with the perl modules for NT not being
able to talk to the database.
</para>
</question>
<answer>
<para>
Your modules may be outdated or inaccurate. Try:
<orderedlist>
<listitem>
<para>
Hitting <ulink url="http://www.activestate.com/ActivePerl"/>
</para>
</listitem>
<listitem>
<para>
Download ActivePerl
</para>
</listitem>
<listitem>
<para>
Go to your prompt
</para>
</listitem>
<listitem>
<para>
Type 'ppm'
</para>
</listitem>
<listitem>
<para>
<prompt>PPM></prompt> <command>install DBI DBD-mysql GD</command>
</para>
</listitem>
</orderedlist>
I reckon TimeDate comes with the activeperl.
You can check the ActiveState site for packages for installation
through PPM. <ulink url="http://www.activestate.com/Packages/"/>.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-use">
<title>Bugzilla Usage</title>
<qandaentry>
<question id="faq-use-changeaddress">
<para>
How do I change my user name (email address) in Bugzilla?
</para>
</question>
<answer>
<para>
You can change your email address from the Name and Password
section in Preferences. You will be emailed at both the old
and new addresses for confirmation. 'Administrative Policies'
must have the 'allowemailchange' parameter set to <quote>On</quote>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-use-query">
<para>
The query page is very confusing.
Isn't there a simpler way to query?
</para>
</question>
<answer>
<para>
The interface was simplified by a UI designer for 2.16. Further
suggestions for improvement are welcome, but we won't sacrifice
power for simplicity.
</para>
<para>
As of 2.18, there is also a 'simpler' search available. At the top
of the search page are two links; <quote>Advanced Search</quote>
will take you to the familiar full-power/full-complexity search
page. The <quote>Find a Specific Bug</quote> link will take you
to a much-simplified page where you can pick a product and
status (open,closed, or both), then enter words that appear in
the bug you want to find. This search will scour the 'Summary'
and 'Comment' fields, and return a list of bugs sorted so that
the bugs with the most hits/matches are nearer to the top.
</para>
<note>
<para>
Matches in the Summary will 'trump' matches in comments,
and bugs with summary-matches will be placed higher in
the buglist -- even if a lower-ranked bug has more matches
in the comments section.
</para>
</note>
<para>
Bugzilla uses a cookie to remember which version of the page
you visited last, and brings that page up when you next do a
search. The default page for new users (or after an upgrade)
is the 'simple' search.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-use-accept">
<para>
I'm confused by the behavior of the <quote>Accept</quote>
button in the Show Bug form. Why doesn't it assign the bug
to me when I accept it?
</para>
</question>
<answer>
<para>
The current behavior is acceptable to bugzilla.mozilla.org and
most users. If you want to change this behavior, though, you
have your choice of patches:
<simplelist>
<member>
<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=35195">Bug 35195</ulink>
seeks to add an <quote>...and accept the bug</quote> checkbox
to the UI. It has two patches attached to it:
<ulink url="https://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029">attachment 8029</ulink>
was originally created for Bugzilla 2.12, while
<ulink url="https://bugzilla.mozilla.org/showattachment.cgi?attach_id=91372">attachment 91372</ulink>
is an updated version for Bugzilla 2.16
</member>
<member>
<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=37613">Bug
37613</ulink> also provides two patches (against Bugzilla
2.12): one to add a 'Take Bug' option, and the other to
automatically reassign the bug on 'Accept'.
</member>
</simplelist>
These patches are all somewhat dated now, and cannot be applied
directly, but they are simple enough to provide a guide on how
Bugzilla can be customized and updated to suit your needs.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-use-attachment">
<para>
I can't upload anything into the database via the
<quote>Create Attachment</quote> link. What am I doing wrong?
</para>
</question>
<answer>
<para>
The most likely cause is a very old browser or a browser that is
incompatible with file upload via POST. Download the latest version
of your favourite browser to handle uploads correctly.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-use-keyword">
<para>
How do I change a keyword in Bugzilla, once some bugs are using it?
</para>
</question>
<answer>
<para>
In the Bugzilla administrator UI, edit the keyword and
it will let you replace the old keyword name with a new one.
This will cause a problem with the keyword cache; run
<command>sanitycheck.cgi</command> to fix it.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-use-close">
<para>
Why can't I close bugs from the <quote>Change Several Bugs
at Once</quote> page?
</para>
</question>
<answer>
<para>
Simple answer; you can.
</para>
<para>
The logic behind the page checks every bug in the list to
determine legal state changes, and then only shows you controls
to do things that could apply to <emphasis>every</emphasis> bug
on the list. The reason for this is that if you try to do something
illegal to a bug, the whole process will grind to a halt, and all
changes after the failed one will <emphasis>also</emphasis> fail.
Since that isn't a good outcome, the page doesn't even present
you with the option.
</para>
<para>
In practical terms, that means that in order to mark
multiple bugs as CLOSED, then every bug on the page has to be
either RESOLVED or VERIFIED already; if this is not the case,
then the option to close the bugs will not appear on the page.
</para>
<para>
The rationale is that if you pick one of the bugs that's not
VERIFIED and try to CLOSE it, the bug change will fail
miserably (thus killing any changes in the list after it
while doing the bulk change) so it doesn't even give you the
choice.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv id="faq-hacking">
<title>Bugzilla Hacking</title>
<qandaentry>
<question id="faq-hacking-templatestyle">
<para>
What kind of style should I use for templatization?
</para>
</question>
<answer>
<para>
Gerv and Myk suggest a 2-space indent, with embedded code sections on
their own line, in line with outer tags. Like this:</para>
<programlisting><![CDATA[
<fred>
[% IF foo %]
<bar>
[% FOREACH x = barney %]
<tr>
<td>
[% x %]
</td>
<tr>
[% END %]
[% END %]
</fred>
]]></programlisting>
<para> Myk also recommends you turn on PRE_CHOMP in the template
initialization to prevent bloating of HTML with unnecessary whitespace.
</para>
<para>Please note that many have differing opinions on this subject,
and the existing templates in Bugzilla espouse both this and a 4-space
style. Either is acceptable; the above is preferred.</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-hacking-bugzillabugs">
<para>
What bugs are in Bugzilla right now?
</para>
</question>
<answer>
<para>
Try <ulink url="https://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;product=Bugzilla">
this link</ulink> to view current bugs or requests for
enhancement for Bugzilla.
</para>
<para>
You can view bugs marked for &bz-nextver; release
<ulink url="https://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&amp;target_milestone=Bugzilla+&amp;bz-nextver;">here</ulink>.
This list includes bugs for the &bz-nextver; release that have already
been fixed and checked into CVS. Please consult the
<ulink url="http://www.bugzilla.org/">
Bugzilla Project Page</ulink> for details on how to
check current sources out of CVS so you can have these
bug fixes early!
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-hacking-priority">
<para>
How can I change the default priority to a null value?
For instance, have the default priority be <quote>---</quote>
instead of <quote>P2</quote>?
</para>
</question>
<answer>
<para>
This is well-documented in <ulink
url="https://bugzilla.mozilla.org/show_bug.cgi?id=49862">bug
49862</ulink>. Ultimately, it's as easy as adding the
<quote>---</quote> priority field to your localconfig file
in the appropriate area, re-running checksetup.pl, and then
changing the default priority in your browser using
<command>editparams.cgi</command>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question id="faq-hacking-patches">
<para>
What's the best way to submit patches? What guidelines
should I follow?
</para>
</question>
<answer>
<blockquote>
<orderedlist>
<listitem>
<para>
Enter a bug into bugzilla.mozilla.org for the <quote><ulink
url="https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">Bugzilla</ulink></quote>
product.
</para>
</listitem>
<listitem>
<para>
Upload your patch as a unified diff (having used <quote>diff
-u</quote> against the <emphasis>current sources</emphasis>
checked out of CVS), or new source file by clicking
<quote>Create a new attachment</quote> link on the bug
page you've just created, and include any descriptions of
database changes you may make, into the bug ID you submitted
in step #1. Be sure and click the <quote>Patch</quote> checkbox
to indicate the text you are sending is a patch!
</para>
</listitem>
<listitem>
<para>
Announce your patch and the associated URL
(https://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX)
for discussion in the newsgroup
(mozilla.support.bugzilla). You'll get a
really good, fairly immediate reaction to the
implications of your patch, which will also give us
an idea how well-received the change would be.
</para>
</listitem>
<listitem>
<para>
If it passes muster with minimal modification, the
person to whom the bug is assigned in Bugzilla is
responsible for seeing the patch is checked into CVS.
</para>
</listitem>
<listitem>
<para>
Bask in the glory of the fact that you helped write
the most successful open-source bug-tracking software
on the planet :)
</para>
</listitem>
</orderedlist>
</blockquote>
</answer>
</qandaentry>
</qandadiv>
</qandaset>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
--- File/Temp.pm.orig Thu Feb 6 16:26:00 2003
+++ File/Temp.pm Thu Feb 6 16:26:23 2003
@@ -205,6 +205,7 @@
# eg CGI::Carp
local $SIG{__DIE__} = sub {};
local $SIG{__WARN__} = sub {};
+ local *CORE::GLOBAL::die = sub {};
$bit = &$func();
1;
};
@@ -226,6 +227,7 @@
# eg CGI::Carp
local $SIG{__DIE__} = sub {};
local $SIG{__WARN__} = sub {};
+ local *CORE::GLOBAL::die = sub {};
$bit = &$func();
1;
};
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="gfdl">
<title>GNU Free Documentation License</title>
<!-- - GNU Project - Free Software Foundation (FSF) -->
<!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" -->
<!-- section>
<title>GNU Free Documentation License</title -->
<para>Version 1.1, March 2000</para>
<blockquote>
<para>Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place,
Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and
distribute verbatim copies of this license document, but changing it is
not allowed.</para>
</blockquote>
<section label="0" id="gfdl-0">
<title>Preamble</title>
<para>The purpose of this License is to make a manual, textbook, or other
written document "free" in the sense of freedom: to assure everyone the
effective freedom to copy and redistribute it, with or without modifying
it, either commercially or noncommercially. Secondarily, this License
preserves for the author and publisher a way to get credit for their
work, while not being considered responsible for modifications made by
others.</para>
<para>This License is a kind of "copyleft", which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft license
designed for free software.</para>
<para>We have designed this License in order to use it for manuals for
free software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals; it
can be used for any textual work, regardless of subject matter or whether
it is published as a printed book. We recommend this License principally
for works whose purpose is instruction or reference.</para>
</section>
<section label="1" id="gfdl-1">
<title>Applicability and Definition</title>
<para>This License applies to any manual or other work that contains a
notice placed by the copyright holder saying it can be distributed under
the terms of this License. The "Document", below, refers to any such
manual or work. Any member of the public is a licensee, and is addressed
as "you".</para>
<para>A "Modified Version" of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.</para>
<para>A "Secondary Section" is a named appendix or a front-matter section
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall subject
(or to related matters) and contains nothing that could fall directly
within that overall subject. (For example, if the Document is in part a
textbook of mathematics, a Secondary Section may not explain any
mathematics.) The relationship could be a matter of historical connection
with the subject or with related matters, or of legal, commercial,
philosophical, ethical or political position regarding them.</para>
<para>The "Invariant Sections" are certain Secondary Sections whose
titles are designated, as being those of Invariant Sections, in the
notice that says that the Document is released under this License.</para>
<para>The "Cover Texts" are certain short passages of text that are
listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says
that the Document is released under this License.</para>
<para>A "Transparent" copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the general
public, whose contents can be viewed and edited directly and
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or for
automatic translation to a variety of formats suitable for input to text
formatters. A copy made in an otherwise Transparent file format whose
markup has been designed to thwart or discourage subsequent modification
by readers is not Transparent. A copy that is not "Transparent" is called
"Opaque".</para>
<para>Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, LaTeX input format, SGML or
XML using a publicly available DTD, and standard-conforming simple HTML
designed for human modification. Opaque formats include PostScript, PDF,
proprietary formats that can be read and edited only by proprietary word
processors, SGML or XML for which the DTD and/or processing tools are not
generally available, and the machine-generated HTML produced by some word
processors for output purposes only.</para>
<para>The "Title Page" means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in formats
which do not have any title page as such, "Title Page" means the text
near the most prominent appearance of the work's title, preceding the
beginning of the body of the text.</para>
</section>
<section label="2" id="gfdl-2">
<title>Verbatim Copying</title>
<para>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies to
the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use technical
measures to obstruct or control the reading or further copying of the
copies you make or distribute. However, you may accept compensation in
exchange for copies. If you distribute a large enough number of copies
you must also follow the conditions in section 3.</para>
<para>You may also lend copies, under the same conditions stated above,
and you may publicly display copies.</para>
</section>
<section label="3" id="gfdl-3">
<title>Copying in Quantity</title>
<para>If you publish printed copies of the Document numbering more than
100, and the Document's license notice requires Cover Texts, you must
enclose the copies in covers that carry, clearly and legibly, all these
Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts
on the back cover. Both covers must also clearly and legibly identify you
as the publisher of these copies. The front cover must present the full
title with all words of the title equally prominent and visible. You may
add other material on the covers in addition. Copying with changes
limited to the covers, as long as they preserve the title of the Document
and satisfy these conditions, can be treated as verbatim copying in other
respects.</para>
<para>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit reasonably)
on the actual cover, and continue the rest onto adjacent pages.</para>
<para>If you publish or distribute Opaque copies of the Document
numbering more than 100, you must either include a machine-readable
Transparent copy along with each Opaque copy, or state in or with each
Opaque copy a publicly-accessible computer-network location containing a
complete Transparent copy of the Document, free of added material, which
the general network-using public has access to download anonymously at no
charge using public-standard network protocols. If you use the latter
option, you must take reasonably prudent steps, when you begin
distribution of Opaque copies in quantity, to ensure that this
Transparent copy will remain thus accessible at the stated location until
at least one year after the last time you distribute an Opaque copy
(directly or through your agents or retailers) of that edition to the
public.</para>
<para>It is requested, but not required, that you contact the authors of
the Document well before redistributing any large number of copies, to
give them a chance to provide you with an updated version of the
Document.</para>
</section>
<section label="4" id="gfdl-4">
<title>Modifications</title>
<para>You may copy and distribute a Modified Version of the Document
under the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution and
modification of the Modified Version to whoever possesses a copy of it.
In addition, you must do these things in the Modified Version:</para>
<orderedlist numeration="upperalpha">
<listitem>
<para>Use in the Title Page (and on the covers, if any) a title
distinct from that of the Document, and from those of previous
versions (which should, if there were any, be listed in the History
section of the Document). You may use the same title as a previous
version if the original publisher of that version gives
permission.</para>
</listitem>
<listitem>
<para>List on the Title Page, as authors, one or more persons or
entities responsible for authorship of the modifications in the
Modified Version, together with at least five of the principal
authors of the Document (all of its principal authors, if it has less
than five).</para>
</listitem>
<listitem>
<para>State on the Title page the name of the publisher of the
Modified Version, as the publisher.</para>
</listitem>
<listitem>
<para>Preserve all the copyright notices of the Document.</para>
</listitem>
<listitem>
<para>Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.</para>
</listitem>
<listitem>
<para>Include, immediately after the copyright notices, a license
notice giving the public permission to use the Modified Version under
the terms of this License, in the form shown in the Addendum
below.</para>
</listitem>
<listitem>
<para>Preserve in that license notice the full lists of Invariant
Sections and required Cover Texts given in the Document's license
notice.</para>
</listitem>
<listitem>
<para>Include an unaltered copy of this License.</para>
</listitem>
<listitem>
<para>Preserve the section entitled "History", and its title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section entitled "History" in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.</para>
</listitem>
<listitem>
<para>Preserve the network location, if any, given in the Document
for public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions it
was based on. These may be placed in the "History" section. You may
omit a network location for a work that was published at least four
years before the Document itself, or if the original publisher of the
version it refers to gives permission.</para>
</listitem>
<listitem>
<para>In any section entitled "Acknowledgements" or "Dedications",
preserve the section's title, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.</para>
</listitem>
<listitem>
<para>Preserve all the Invariant Sections of the Document, unaltered
in their text and in their titles. Section numbers or the equivalent
are not considered part of the section titles.</para>
</listitem>
<listitem>
<para>Delete any section entitled "Endorsements". Such a section may
not be included in the Modified Version.</para>
</listitem>
<listitem>
<para>Do not retitle any existing section as "Endorsements" or to
conflict in title with any Invariant Section.</para>
</listitem>
</orderedlist>
<para>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all of
these sections as invariant. To do this, add their titles to the list of
Invariant Sections in the Modified Version's license notice. These titles
must be distinct from any other section titles.</para>
<para>You may add a section entitled "Endorsements", provided it contains
nothing but endorsements of your Modified Version by various parties--for
example, statements of peer review or that the text has been approved by
an organization as the authoritative definition of a standard.</para>
<para>You may add a passage of up to five words as a Front-Cover Text,
and a passage of up to 25 words as a Back-Cover Text, to the end of the
list of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or through
arrangements made by) any one entity. If the Document already includes a
cover text for the same cover, previously added by you or by arrangement
made by the same entity you are acting on behalf of, you may not add
another; but you may replace the old one, on explicit permission from the
previous publisher that added the old one.</para>
<para>The author(s) and publisher(s) of the Document do not by this
License give permission to use their names for publicity for or to assert
or imply endorsement of any Modified Version.</para>
</section>
<section label="5" id="gfdl-5">
<title>Combining Documents</title>
<para>You may combine the Document with other documents released under
this License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and list
them all as Invariant Sections of your combined work in its license
notice.</para>
<para>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single copy.
If there are multiple Invariant Sections with the same name but different
contents, make the title of each such section unique by adding at the end
of it, in parentheses, the name of the original author or publisher of
that section if known, or else a unique number. Make the same adjustment
to the section titles in the list of Invariant Sections in the license
notice of the combined work.</para>
<para>In the combination, you must combine any sections entitled
"History" in the various original documents, forming one section entitled
"History"; likewise combine any sections entitled "Acknowledgements", and
any sections entitled "Dedications". You must delete all sections
entitled "Endorsements."</para>
</section>
<section label="6" id="gfdl-6">
<title>Collections of Documents</title>
<para>You may make a collection consisting of the Document and other
documents released under this License, and replace the individual copies
of this License in the various documents with a single copy that is
included in the collection, provided that you follow the rules of this
License for verbatim copying of each of the documents in all other
respects.</para>
<para>You may extract a single document from such a collection, and
distribute it individually under this License, provided you insert a copy
of this License into the extracted document, and follow this License in
all other respects regarding verbatim copying of that document.</para>
</section>
<section label="7" id="gfdl-7">
<title>Aggregation with Independent Works</title>
<para>A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume of a
storage or distribution medium, does not as a whole count as a Modified
Version of the Document, provided no compilation copyright is claimed for
the compilation. Such a compilation is called an "aggregate", and this
License does not apply to the other self-contained works thus compiled
with the Document, on account of their being thus compiled, if they are
not themselves derivative works of the Document.</para>
<para>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one quarter of
the entire aggregate, the Document's Cover Texts may be placed on covers
that surround only the Document within the aggregate. Otherwise they must
appear on covers around the whole aggregate.</para>
</section>
<section label="8" id="gfdl-8">
<title>Translation</title>
<para>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include translations
of some or all Invariant Sections in addition to the original versions of
these Invariant Sections. You may include a translation of this License
provided that you also include the original English version of this
License. In case of a disagreement between the translation and the
original English version of this License, the original English version
will prevail.</para>
</section>
<section label="9" id="gfdl-9">
<title>Termination</title>
<para>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided for under this License. Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However, parties
who have received copies, or rights, from you under this License will not
have their licenses terminated so long as such parties remain in full
compliance.</para>
</section>
<section label="10" id="gfdl-10">
<title>Future Revisions of this License</title>
<para>The Free Software Foundation may publish new, revised versions of
the GNU Free Documentation License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in
detail to address new problems or concerns. See
<ulink url="http://www.gnu.org/copyleft/"/>.</para>
<para>Each version of the License is given a distinguishing version
number. If the Document specifies that a particular numbered version of
this License "or any later version" applies to it, you have the option of
following the terms and conditions either of that specified version or of
any later version that has been published (not as a draft) by the Free
Software Foundation. If the Document does not specify a version number of
this License, you may choose any version ever published (not as a draft)
by the Free Software Foundation.</para>
</section>
<section label="" id="gfdl-howto">
<title>How to use this License for your documents</title>
<para>To use this License in a document you have written, include a copy
of the License in the document and put the following copyright and
license notices just after the title page:</para>
<blockquote>
<para>Copyright (c) YEAR YOUR NAME. Permission is granted to copy,
distribute and/or modify this document under the terms of the GNU Free
Documentation License, Version 1.1 or any later version published by
the Free Software Foundation; with the Invariant Sections being LIST
THEIR TITLES, with the Front-Cover Texts being LIST, and with the
Back-Cover Texts being LIST. A copy of the license is included in the
section entitled "GNU Free Documentation License".</para>
</blockquote>
<para>If you have no Invariant Sections, write "with no Invariant
Sections" instead of saying which ones are invariant. If you have no
Front-Cover Texts, write "no Front-Cover Texts" instead of "Front-Cover
Texts being LIST"; likewise for Back-Cover Texts.</para>
<para>If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of free
software license, such as the GNU General Public License, to permit their
use in free software.</para>
</section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<glossary id="glossary">
<glossdiv>
<title>0-9, high ascii</title>
<glossentry id="gloss-htaccess">
<glossterm>.htaccess</glossterm>
<glossdef>
<para>Apache web server, and other NCSA-compliant web servers,
observe the convention of using files in directories called
<filename>.htaccess</filename>
to restrict access to certain files. In Bugzilla, they are used
to keep secret files which would otherwise
compromise your installation - e.g. the
<filename>localconfig</filename>
file contains the password to your database.
curious.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-a">
<title>A</title>
<glossentry id="gloss-apache">
<glossterm>Apache</glossterm>
<glossdef>
<para>In this context, Apache is the web server most commonly used
for serving up Bugzilla
pages. Contrary to popular belief, the apache web server has nothing
to do with the ancient and noble Native American tribe, but instead
derived its name from the fact that it was
<quote>a patchy</quote>
version of the original
<acronym>NCSA</acronym>
world-wide-web server.</para>
<variablelist>
<title>Useful Directives when configuring Bugzilla</title>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#addhandler">AddHandler</ulink></computeroutput></term>
<listitem>
<para>Tell Apache that it's OK to run CGI scripts.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride">AllowOverride</ulink></computeroutput></term>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#options">Options</ulink></computeroutput></term>
<listitem>
<para>These directives are used to tell Apache many things about
the directory they apply to. For Bugzilla's purposes, we need
them to allow script execution and <filename>.htaccess</filename>
overrides.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex">DirectoryIndex</ulink></computeroutput></term>
<listitem>
<para>Used to tell Apache what files are indexes. If you can
not add <filename>index.cgi</filename> to the list of valid files,
you'll need to set <computeroutput>$index_html</computeroutput> to
1 in <filename>localconfig</filename> so
<command>./checksetup.pl</command> will create an
<filename>index.html</filename> that redirects to
<filename>index.cgi</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">ScriptInterpreterSource</ulink></computeroutput></term>
<listitem>
<para>Used when running Apache on windows so the shebang line
doesn't have to be changed in every Bugzilla script.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>For more information about how to configure Apache for Bugzilla,
see <xref linkend="http-apache"/>.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-b">
<title>B</title>
<glossentry>
<glossterm>Bug</glossterm>
<glossdef>
<para>A
<quote>bug</quote>
in Bugzilla refers to an issue entered into the database which has an
associated number, assignments, comments, etc. Some also refer to a
<quote>tickets</quote>
or
<quote>issues</quote>;
in the context of Bugzilla, they are synonymous.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>Bug Number</glossterm>
<glossdef>
<para>Each Bugzilla bug is assigned a number that uniquely identifies
that bug. The bug associated with a bug number can be pulled up via a
query, or easily from the very front page by typing the number in the
"Find" box.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-bugzilla">
<glossterm>Bugzilla</glossterm>
<glossdef>
<para>Bugzilla is the world-leading free software bug tracking system.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-c">
<title>C</title>
<glossentry id="gloss-cgi">
<glossterm>Common Gateway Interface</glossterm>
<acronym>CGI</acronym>
<glossdef>
<para><acronym>CGI</acronym> is an acronym for Common Gateway Interface. This is
a standard for interfacing an external application with a web server. Bugzilla
is an example of a <acronym>CGI</acronym> application.
</para>
</glossdef>
</glossentry>
<glossentry id="gloss-component">
<glossterm>Component</glossterm>
<glossdef>
<para>A Component is a subsection of a Product. It should be a narrow
category, tailored to your organization. All Products must contain at
least one Component (and, as a matter of fact, creating a Product
with no Components will create an error in Bugzilla).</para>
</glossdef>
</glossentry>
<glossentry id="gloss-cpan">
<glossterm>Comprehensive Perl Archive Network</glossterm>
<acronym>CPAN</acronym>
<!-- TODO: Rewrite def for CPAN -->
<glossdef>
<para>
<acronym>CPAN</acronym>
stands for the
<quote>Comprehensive Perl Archive Network</quote>.
CPAN maintains a large number of extremely useful
<glossterm>Perl</glossterm>
modules - encapsulated chunks of code for performing a
particular task.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-contrib">
<glossterm><filename class="directory">contrib</filename></glossterm>
<glossdef>
<para>The <filename class="directory">contrib</filename> directory is
a location to put scripts that have been contributed to Bugzilla but
are not a part of the official distribution. These scripts are written
by third parties and may be in languages other than perl. For those
that are in perl, there may be additional modules or other requirements
than those of the official distribution.
<note>
<para>Scripts in the <filename class="directory">contrib</filename>
directory are not officially supported by the Bugzilla team and may
break in between versions.
</para>
</note>
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-d">
<title>D</title>
<glossentry id="gloss-daemon">
<glossterm>daemon</glossterm>
<glossdef>
<para>A daemon is a computer program which runs in the background. In
general, most daemons are started at boot time via System V init
scripts, or through RC scripts on BSD-based systems.
<glossterm>mysqld</glossterm>,
the MySQL server, and
<glossterm>apache</glossterm>,
a web server, are generally run as daemons.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-dos">
<glossterm>DOS Attack</glossterm>
<glossdef>
<para>A DOS, or Denial of Service attack, is when a user attempts to
deny access to a web server by repeatedly accessing a page or sending
malformed requests to a webserver. A D-DOS, or
Distributed Denial of Service attack, is when these requests come
from multiple sources at the same time. Unfortunately, these are much
more difficult to defend against.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-g">
<title>G</title>
<glossentry id="gloss-groups">
<glossterm>Groups</glossterm>
<glossdef>
<para>The word
<quote>Groups</quote>
has a very special meaning to Bugzilla. Bugzilla's main security
mechanism comes by placing users in groups, and assigning those
groups certain privileges to view bugs in particular
<glossterm>Products</glossterm>
in the
<glossterm>Bugzilla</glossterm>
database.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-j">
<title>J</title>
<glossentry id="gloss-javascript">
<glossterm>JavaScript</glossterm>
<glossdef>
<para>JavaScript is cool, we should talk about it.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-m">
<title>M</title>
<glossentry id="gloss-mta">
<glossterm>Message Transport Agent</glossterm>
<acronym>MTA</acronym>
<glossdef>
<para>A Message Transport Agent is used to control the flow of email on a system.
The <ulink url="http://search.cpan.org/dist/Email-Send/lib/Email/Send.pm">Email::Send</ulink>
Perl module, which Bugzilla uses to send email, can be configured to
use many different underlying implementations for actually sending the
mail using the <option>mail_delivery_method</option> parameter.
Implementations other than <literal>sendmail</literal> require that the
<option>sendmailnow</option> param be set to <literal>on</literal>.
</para>
</glossdef>
</glossentry>
<glossentry id="gloss-mysql">
<glossterm>MySQL</glossterm>
<glossdef>
<para>MySQL is currently the required
<glossterm linkend="gloss-rdbms">RDBMS</glossterm> for Bugzilla. MySQL
can be downloaded from <ulink url="http://www.mysql.com"/>. While you
should familiarize yourself with all of the documentation, some high
points are:
</para>
<variablelist>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Backup.html">Backup</ulink></term>
<listitem>
<para>Methods for backing up your Bugzilla database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Option_files.html">Option Files</ulink></term>
<listitem>
<para>Information about how to configure MySQL using
<filename>my.cnf</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><ulink url="http://www.mysql.com/doc/en/Privilege_system.html">Privilege System</ulink></term>
<listitem>
<para>Much more detailed information about the suggestions in
<xref linkend="security-mysql"/>.
</para>
</listitem>
</varlistentry>
</variablelist>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-p">
<title>P</title>
<glossentry id="gloss-ppm">
<glossterm>Perl Package Manager</glossterm>
<acronym>PPM</acronym>
<glossdef>
<para><ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/PPM/"/>
</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm id="gloss-product">Product</glossterm>
<glossdef>
<para>A Product is a broad category of types of bugs, normally
representing a single piece of software or entity. In general,
there are several Components to a Product. A Product may define a
group (used for security) for all bugs entered into
its Components.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>Perl</glossterm>
<glossdef>
<para>First written by Larry Wall, Perl is a remarkable program
language. It has the benefits of the flexibility of an interpreted
scripting language (such as shell script), combined with the speed
and power of a compiled language, such as C.
<glossterm>Bugzilla</glossterm>
is maintained in Perl.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-q">
<title>Q</title>
<glossentry>
<glossterm>QA</glossterm>
<glossdef>
<para>
<quote>QA</quote>,
<quote>Q/A</quote>, and
<quote>Q.A.</quote>
are short for
<quote>Quality Assurance</quote>.
In most large software development organizations, there is a team
devoted to ensuring the product meets minimum standards before
shipping. This team will also generally want to track the progress of
bugs over their life cycle, thus the need for the
<quote>QA Contact</quote>
field in a bug.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-r">
<title>R</title>
<glossentry id="gloss-rdbms">
<glossterm>Relational DataBase Management System</glossterm>
<acronym>RDBMS</acronym>
<glossdef>
<para>A relational database management system is a database system
that stores information in tables that are related to each other.
</para>
</glossdef>
</glossentry>
<glossentry id="gloss-regexp">
<glossterm>Regular Expression</glossterm>
<acronym>regexp</acronym>
<glossdef>
<para>A regular expression is an expression used for pattern matching.
<ulink url="http://perldoc.com/perl5.6/pod/perlre.html#Regular-Expressions">Documentation</ulink>
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-s">
<title>S</title>
<glossentry id="gloss-service">
<glossterm>Service</glossterm>
<glossdef>
<para>In Windows NT environment, a boot-time background application
is referred to as a service. These are generally managed through the
control panel while logged in as an account with
<quote>Administrator</quote> level capabilities. For more
information, consult your Windows manual or the MSKB.
</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>
<acronym>SGML</acronym>
</glossterm>
<glossdef>
<para>
<acronym>SGML</acronym>
stands for
<quote>Standard Generalized Markup Language</quote>.
Created in the 1980's to provide an extensible means to maintain
documentation based upon content instead of presentation,
<acronym>SGML</acronym>
has withstood the test of time as a robust, powerful language.
<glossterm>
<acronym>XML</acronym>
</glossterm>
is the
<quote>baby brother</quote>
of SGML; any valid
<acronym>XML</acronym>
document it, by definition, a valid
<acronym>SGML</acronym>
document. The document you are reading is written and maintained in
<acronym>SGML</acronym>,
and is also valid
<acronym>XML</acronym>
if you modify the Document Type Definition.</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-t">
<title>T</title>
<glossentry id="gloss-target-milestone" xreflabel="Target Milestone">
<glossterm>Target Milestone</glossterm>
<glossdef>
<para>Target Milestones are Product goals. They are configurable on a
per-Product basis. Most software development houses have a concept of
<quote>milestones</quote>
where the people funding a project expect certain functionality on
certain dates. Bugzilla facilitates meeting these milestones by
giving you the ability to declare by which milestone a bug will be
fixed, or an enhancement will be implemented.</para>
</glossdef>
</glossentry>
<glossentry id="gloss-tcl">
<glossterm>Tool Command Language</glossterm>
<acronym>TCL</acronym>
<glossdef>
<para>TCL is an open source scripting language available for Windows,
Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but
never released. The first release of Bugzilla was 2.0, which was when
it was ported to perl.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id="gloss-z">
<title>Z</title>
<glossentry id="gloss-zarro">
<glossterm>Zarro Boogs Found</glossterm>
<glossdef>
<para>This is just a goofy way of saying that there were no bugs
found matching your query. When asked to explain this message,
Terry had the following to say:
</para>
<blockquote>
<attribution>Terry Weissman</attribution>
<para>I've been asked to explain this ... way back when, when
Netscape released version 4.0 of its browser, we had a release
party. Naturally, there had been a big push to try and fix every
known bug before the release. Naturally, that hadn't actually
happened. (This is not unique to Netscape or to 4.0; the same thing
has happened with every software project I've ever seen.) Anyway,
at the release party, T-shirts were handed out that said something
like "Netscape 4.0: Zarro Boogs". Just like the software, the
T-shirt had no known bugs. Uh-huh.
</para>
<para>So, when you query for a list of bugs, and it gets no results,
you can think of this as a friendly reminder. Of *course* there are
bugs matching your query, they just aren't in the bugsystem yet...
</para>
</blockquote>
</glossdef>
</glossentry>
</glossdiv>
</glossary>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: installation.xml,v 1.155 2008/02/24 19:23:06 lpsolit%gmail.com Exp $ -->
<chapter id="installing-bugzilla">
<title>Installing Bugzilla</title>
<section id="installation">
<title>Installation</title>
<note>
<para>If you just want to <emphasis>use</emphasis> Bugzilla,
you do not need to install it. None of this chapter is relevant to
you. Ask your Bugzilla administrator for the URL to access it from
your web browser.
</para>
</note>
<para>The Bugzilla server software is usually installed on Linux or
Solaris.
If you are installing on another OS, check <xref linkend="os-specific"/>
before you start your installation to see if there are any special
instructions.
</para>
<para>
As an alternative to following these instructions, you may wish to
try Arne Schirmacher's unofficial and unsupported
<ulink url="http://www.softwaretesting.de/article/view/33/1/8/">Bugzilla
Installer</ulink>, which installs Bugzilla and all its prerequisites
on Linux or Solaris systems.
</para>
<para>This guide assumes that you have administrative access to the
Bugzilla machine. It not possible to
install and run Bugzilla itself without administrative access except
in the very unlikely event that every single prerequisite is
already installed.
</para>
<warning>
<para>The installation process may make your machine insecure for
short periods of time. Make sure there is a firewall between you
and the Internet.
</para>
</warning>
<para>
You are strongly recommended to make a backup of your system
before installing Bugzilla (and at regular intervals thereafter :-).
</para>
<para>In outline, the installation proceeds as follows:
</para>
<procedure>
<step>
<para><link linkend="install-perl">Install Perl</link>
(&min-perl-ver; or above)
</para>
</step>
<step>
<para><link linkend="install-database">Install a Database Engine</link>
</para>
</step>
<step>
<para><link linkend="install-webserver">Install a Webserver</link>
</para>
</step>
<step>
<para><link linkend="install-bzfiles">Install Bugzilla</link>
</para>
</step>
<step>
<para><link linkend="install-perlmodules">Install Perl modules</link>
</para>
</step>
<step>
<para>
<link linkend="install-MTA">Install a Mail Transfer Agent</link>
(Sendmail 8.7 or above, or an MTA that is Sendmail-compatible with at least this version)
</para>
</step>
<step>
<para>Configure all of the above.
</para>
</step>
</procedure>
<section id="install-perl">
<title>Perl</title>
<para>Installed Version Test: <filename>perl -v</filename></para>
<para>Any machine that doesn't have Perl on it is a sad machine indeed.
If you don't have it and your OS doesn't provide official packages,
visit <ulink url="http://www.perl.com"/>.
Although Bugzilla runs with Perl &min-perl-ver;,
it's a good idea to be using the latest stable version.
</para>
</section>
<section id="install-database">
<title>Database Engine</title>
<para>From Bugzilla 2.20, support is included for using both the MySQL and
PostgreSQL database servers. You only require one of these systems to make
use of Bugzilla.</para>
<section id="install-mysql">
<title>MySQL</title>
<para>Installed Version Test: <filename>mysql -V</filename></para>
<para>
If you don't have it and your OS doesn't provide official packages,
visit <ulink url="http://www.mysql.com"/>. You need MySQL version
&min-mysql-ver; or higher.
</para>
<note>
<para> Many of the binary
versions of MySQL store their data files in
<filename class="directory">/var</filename>.
On some Unix systems, this is part of a smaller root partition,
and may not have room for your bug database. To change the data
directory, you have to build MySQL from source yourself, and
set it as an option to <filename>configure</filename>.</para>
</note>
<para>If you install from something other than a packaging/installation
system, such as .rpm (Redhat Package), .deb (Debian Package), .exe
(Windows Executable), or .msi (Microsoft Installer), make sure the MySQL
server is started when the machine boots.
</para>
</section>
<section id="install-pg">
<title>PostgreSQL</title>
<para>Installed Version Test: <filename>psql -V</filename></para>
<para>
If you don't have it and your OS doesn't provide official packages,
visit <ulink url="http://www.postgresql.org/"/>. You need PostgreSQL
version &min-pg-ver; or higher.
</para>
<para>If you install from something other than a packaging/installation
system, such as .rpm (Redhat Package), .deb (Debian Package), .exe
(Windows Executable), or .msi (Microsoft Installer), make sure the
PostgreSQL server is started when the machine boots.
</para>
</section>
</section>
<section id="install-webserver">
<title>Web Server</title>
<para>Installed Version Test: view the default welcome page at
http://&lt;your-machine&gt;/</para>
<para>You have freedom of choice here, pretty much any web server that
is capable of running <glossterm linkend="gloss-cgi">CGI</glossterm>
scripts will work.
However, we strongly recommend using the Apache web server
(either 1.3.x or 2.x), and
the installation instructions usually assume you are
using it. If you have got Bugzilla working using another web server,
please share your experiences with us by filing a bug in &bzg-bugs;.
</para>
<para>
If you don't have Apache and your OS doesn't provide official packages,
visit <ulink url="http://httpd.apache.org/"/>.
</para>
</section>
<section id="install-bzfiles">
<title>Bugzilla</title>
<para>
Download a Bugzilla tarball (or check it out from CVS) and place
it in a suitable directory, accessible by the default web server user
(probably <quote>apache</quote> or <quote>www</quote>).
Good locations are either directly in the web server's document directories or
in <filename>/usr/local</filename> with a symbolic link to the web server's
document directories or an alias in the web server's configuration.
</para>
<caution>
<para>The default Bugzilla distribution is NOT designed to be placed
in a <filename class="directory">cgi-bin</filename> directory. This
includes any directory which is configured using the
<option>ScriptAlias</option> directive of Apache.
</para>
</caution>
<para>Once all the files are in a web accessible directory, make that
directory writable by your web server's user. This is a temporary step
until you run the
<filename>checksetup.pl</filename>
script, which locks down your installation.</para>
</section>
<section id="install-perlmodules">
<title>Perl Modules</title>
<para>Bugzilla's installation process is based
on a script called <filename>checksetup.pl</filename>.
The first thing it checks is whether you have appropriate
versions of all the required
Perl modules. The aim of this section is to pass this check.
When it passes, proceed to <xref linkend="configuration"/>.
</para>
<para>
At this point, you need to <filename>su</filename> to root. You should
remain as root until the end of the install. To check you have the
required modules, run:
</para>
<screen><prompt>bash#</prompt> ./checksetup.pl --check-modules</screen>
<para>
<filename>checksetup.pl</filename> will print out a list of the
required and optional Perl modules, together with the versions
(if any) installed on your machine.
The list of required modules is reasonably long; however, you
may already have several of them installed.
</para>
<para>
There is a meta-module called Bundle::Bugzilla,
which installs all the other
modules with a single command. You should use this if you are running
Perl 5.6.1 or above.
</para>
<para>
The preferred way of installing Perl modules is via CPAN on Unix,
or PPM on Windows (see <xref linkend="win32-perl-modules"/>). These
instructions assume you are using CPAN; if for some reason you need
to install the Perl modules manually, see
<xref linkend="install-perlmodules-manual"/>.
</para>
<screen><prompt>bash#</prompt> perl -MCPAN -e 'install "&lt;modulename&gt;"'</screen>
<para>
If you using Bundle::Bugzilla, invoke the magic CPAN command on it.
Otherwise, you need to work down the
list of modules that <filename>checksetup.pl</filename> says are
required, in the order given, invoking the command on each.
</para>
<tip>
<para>Many people complain that Perl modules will not install for
them. Most times, the error messages complain that they are missing a
file in
<quote>@INC</quote>.
Virtually every time, this error is due to permissions being set too
restrictively for you to compile Perl modules or not having the
necessary Perl development libraries installed on your system.
Consult your local UNIX systems administrator for help solving these
permissions issues; if you
<emphasis>are</emphasis>
the local UNIX sysadmin, please consult the newsgroup/mailing list
for further assistance or hire someone to help you out.</para>
</tip>
<note>
<para>If you are using a package-based system, and attempting to install the
Perl modules from CPAN, you may need to install the "development" packages for
MySQL and GD before attempting to install the related Perl modules. The names of
these packages will vary depending on the specific distribution you are using,
but are often called <filename>&lt;packagename&gt;-devel</filename>.</para>
</note>
<para>
Here is a complete list of modules and their minimum versions.
Some modules have special installation notes, which follow.
</para>
<para>Required Perl modules:
<orderedlist>
<listitem>
<para>
CGI &min-cgi-ver; or CGI &min-mp-cgi-ver; if using mod_perl
</para>
</listitem>
<listitem>
<para>
Date::Format (&min-date-format-ver;)
</para>
</listitem>
<listitem>
<para>
DBI (&min-dbi-ver;)
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-dbd-mysql">DBD::mysql</link>
(&min-dbd-mysql-ver;) if using MySQL
</para>
</listitem>
<listitem>
<para>
DBD::Pg (&min-dbd-pg-ver;) if using PostgreSQL
</para>
</listitem>
<listitem>
<para>
File::Spec (&min-file-spec-ver;)
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-template">Template</link>
(&min-template-ver;)
</para>
</listitem>
<listitem>
<para>
Email::Send (&min-email-send-ver;)
</para>
</listitem>
<listitem>
<para>
Email::MIME::Modifier (&min-email-mime-modifier-ver;)
</para>
</listitem>
</orderedlist>
Optional Perl modules:
<orderedlist>
<listitem>
<para>
<link linkend="install-modules-gd">GD</link>
(&min-gd-ver;) for bug charting
</para>
</listitem>
<listitem>
<para>
Template::Plugin::GD::Image
(&min-gd-ver;) for Graphical Reports
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-chart-base">Chart::Base</link>
(&min-chart-base-ver;) for bug charting
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-gd-graph">GD::Graph</link>
(&min-gd-graph-ver;) for bug charting
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-gd-text">GD::Text</link>
(&min-gd-text-ver;) for bug charting
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-xml-twig">XML::Twig</link>
(&min-xml-twig-ver;) for bug import/export
</para>
</listitem>
<listitem>
<para>
MIME::Parser (&min-mime-parser-ver;) for bug import/export
</para>
</listitem>
<listitem>
<para>
LWP::UserAgent
(&min-lwp-useragent-ver;) for Automatic Update Notifications
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-patchreader">PatchReader</link>
(&min-patchreader-ver;) for pretty HTML view of patches
</para>
</listitem>
<listitem>
<para>
Image::Magick (&min-image-magick-ver;) for converting BMP image attachments to PNG
</para>
</listitem>
<listitem>
<para>
Net::LDAP
(&min-net-ldap-ver;) for LDAP Authentication
</para>
</listitem>
<listitem>
<para>
Authen::Radius
(&min-authen-radius-ver;) for RADIUS Authentication
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-soap-lite">SOAP::Lite</link>
(&min-soap-lite-ver;) for the web service interface
</para>
</listitem>
<listitem>
<para>
HTML::Parser
(&min-html-parser-ver;) for More HTML in Product/Group Descriptions
</para>
</listitem>
<listitem>
<para>
HTML::Scrubber
(&min-html-scrubber-ver;) for More HTML in Product/Group Descriptions
</para>
</listitem>
<listitem>
<para>
Email::MIME::Attachment::Stripper
(&min-email-mime-attachment-stripper-ver;) for Inbound Email
</para>
</listitem>
<listitem>
<para>
Email::Reply
(&min-email-reply-ver;) for Inbound Email
</para>
</listitem>
<listitem>
<para>
mod_perl2
(&min-mod_perl2-ver;) for mod_perl
</para>
</listitem>
<listitem>
<para>
CGI
(&min-cgi-ver;) for mod_perl
</para>
</listitem>
</orderedlist>
</para>
<section id="install-modules-dbd-mysql">
<title>DBD::mysql</title>
<para>The installation process will ask you a few questions about the
desired compilation target and your MySQL installation. For most of the
questions the provided default will be adequate, but when asked if your
desired target is the MySQL or mSQL packages, you should
select the MySQL-related ones. Later you will be asked if you wish to
provide backwards compatibility with the older MySQL packages; you
should answer YES to this question. The default is NO.</para>
<para>A host of 'localhost' should be fine. A testing user of 'test',
with a null password, should have sufficient access to run
tests on the 'test' database which MySQL creates upon installation.
</para>
</section>
<section id="install-modules-template">
<title>Template Toolkit (&min-template-ver;)</title>
<para>When you install Template Toolkit, you'll get asked various
questions about features to enable. The defaults are fine, except
that it is recommended you use the high speed XS Stash of the Template
Toolkit, in order to achieve best performance.
</para>
</section>
<section id="install-modules-gd">
<title>GD (&min-gd-ver;)</title>
<para>The GD module is only required if you want graphical reports.
</para>
<note>
<para>The Perl GD module requires some other libraries that may or
may not be installed on your system, including
<classname>libpng</classname>
and
<classname>libgd</classname>.
The full requirements are listed in the Perl GD module README.
If compiling GD fails, it's probably because you're
missing a required library.</para>
</note>
<tip>
<para>The version of the GD module you need is very closely tied
to the <classname>libgd</classname> version installed on your system.
If you have a version 1.x of <classname>libgd</classname> the 2.x
versions of the GD module won't work for you.
</para>
</tip>
</section>
<section id="install-modules-chart-base">
<title>Chart::Base (&min-chart-base-ver;)</title>
<para>The Chart::Base module is only required if you want graphical
reports.
Note that earlier versions that 0.99c used GIFs, which are no longer
supported by the latest versions of GD.</para>
</section>
<section id="install-modules-gd-graph">
<title>GD::Graph (&min-gd-graph-ver;)</title>
<para>The GD::Graph module is only required if you want graphical
reports.
</para>
</section>
<section id="install-modules-gd-text">
<title>GD::Text (&min-gd-text-ver;)</title>
<para>The GD::Text module is only required if you want graphical
reports.
</para>
</section>
<section id="install-modules-xml-twig">
<title>XML::Twig (&min-xml-twig-ver;)</title>
<para>The XML::Twig module is only required if you want to import
XML bugs using the <filename>importxml.pl</filename>
script. This is required to use Bugzilla's "move bugs" feature;
you may also want to use it for migrating from another bug database.
</para>
</section>
<section id="install-modules-soap-lite">
<title>SOAP::Lite (&min-soap-lite-ver;)</title>
<para>Installing SOAP::Lite enables your Bugzilla installation to be
accessible at a standardized Web Service interface (SOAP/XML-RPC)
by third-party applications via HTTP(S).
</para>
</section>
<section id="install-modules-patchreader">
<title>PatchReader (&min-patchreader-ver;)</title>
<para>The PatchReader module is only required if you want to use
Patch Viewer, a
Bugzilla feature to show code patches in your web browser in a more
readable form.
</para>
</section>
</section>
<section id="install-MTA">
<title>Mail Transfer Agent (MTA)</title>
<para>
Bugzilla is dependent on the availability of an e-mail system for its
user authentication and for other tasks.
</para>
<note>
<para>
This is not entirely true. It is possible to completely disable
email sending, or to have Bugzilla store email messages in a
file instead of sending them. However, this is mainly intended
for testing, as disabling or diverting email on a production
machine would mean that users could miss important events (such
as bug changes or the creation of new accounts).
</para>
<para>
For more information, see the <quote>mail_delivery_method</quote> parameter
in <xref linkend="parameters" />.
</para>
</note>
<para>
On Linux, any Sendmail-compatible MTA (Mail Transfer Agent) will
suffice. Sendmail, Postfix, qmail and Exim are examples of common
MTAs. Sendmail is the original Unix MTA, but the others are easier to
configure, and therefore many people replace Sendmail with Postfix or
Exim. They are drop-in replacements, so Bugzilla will not
distinguish between them.
</para>
<para>
If you are using Sendmail, version 8.7 or higher is required.
If you are using a Sendmail-compatible MTA, it must be congruent with
at least version 8.7 of Sendmail.
</para>
<para>
Consult the manual for the specific MTA you choose for detailed
installation instructions. Each of these programs will have their own
configuration files where you must configure certain parameters to
ensure that the mail is delivered properly. They are implemented
as services, and you should ensure that the MTA is in the auto-start
list of services for the machine.
</para>
<para>
If a simple mail sent with the command-line 'mail' program
succeeds, then Bugzilla should also be fine.
</para>
</section>
<section id="using-mod_perl-with-bugzilla">
<title>Installing Bugzilla on mod_perl</title>
<para>It is now possible to run the Bugzilla software under <literal>mod_perl</literal> on
Apache. <literal>mod_perl</literal> has some additional requirements to that of running
Bugzilla under <literal>mod_cgi</literal> (the standard and previous way).</para>
<para>Bugzilla requires <literal>mod_perl</literal> to be installed, which can be
obtained from <ulink url="http://perl.apache.org"/> - Bugzilla requires
version &min-mod_perl2-ver; (AKA 2.0.0-RC5) to be installed.</para>
<para>Bugzilla also requires a more up-to-date version of the CGI
perl module to be installed, version &min-mp-cgi-ver; as opposed to &min-cgi-ver;
</para>
</section>
</section>
<section id="configuration">
<title>Configuration</title>
<warning>
<para>
Poorly-configured MySQL and Bugzilla installations have
given attackers full access to systems in the past. Please take the
security parts of these guidelines seriously, even for Bugzilla
machines hidden away behind your firewall. Be certain to read
<xref linkend="security"/> for some important security tips.
</para>
</warning>
<section id="localconfig">
<title>localconfig</title>
<para>
You should now run <filename>checksetup.pl</filename> again, this time
without the <literal>--check-modules</literal> switch.
</para>
<screen><prompt>bash#</prompt> ./checksetup.pl</screen>
<para>
This time, <filename>checksetup.pl</filename> should tell you that all
the correct modules are installed and will display a message about, and
write out a file called, <filename>localconfig</filename>. This file
contains the default settings for a number of Bugzilla parameters.
</para>
<para>
Load this file in your editor. The only value you
<emphasis>need</emphasis> to change is $db_pass, the password for
the user you will create for your database. Pick a strong
password (for simplicity, it should not contain single quote
characters) and put it here.
</para>
<para>
You may need to change the value of
<emphasis>webservergroup</emphasis> if your web server does not
run in the "apache" group. On Debian, for example, Apache runs in
the "www-data" group. If you are going to run Bugzilla on a
machine where you do not have root access (such as on a shared web
hosting account), you will need to leave
<emphasis>webservergroup</emphasis> empty, ignoring the warnings
that <filename>checksetup.pl</filename> will subsequently display
every time it is run.
</para>
<caution>
<para>
If you are using suexec, you should use your own primary group
for <emphasis>webservergroup</emphasis> rather than leaving it
empty, and see the additional directions in the suexec section
<xref linkend="suexec" />.
</para>
</caution>
<para>
The other options in the <filename>localconfig</filename> file
are documented by their accompanying comments. If you have a slightly
non-standard MySQL setup, you may wish to change one or more of
the other "$db_*" parameters.
</para>
<para>
You may also wish to change the names of
the priorities, severities, operating systems and platforms for your
installation. However, you can always change these after installation
has finished; if you then re-run <filename>checksetup.pl</filename>,
the changes will get picked up.
</para>
</section>
<section id="database-engine">
<title>Database Server</title>
<para>
This section deals with configuring your database server for use
with Bugzilla. Currently, MySQL (<xref linkend="mysql"/>) and
PostgreSQL (<xref linkend="postgresql"/>) are available.
</para>
<section id="database-schema">
<title>Bugzilla Database Schema</title>
<para>
The Bugzilla database schema is available at
<ulink url="http://www.ravenbrook.com/project/p4dti/tool/cgi/bugzilla-schema/">Ravenbrook</ulink>.
This very valuable tool can generate a written description of
the Bugzilla database schema for any version of Bugzilla. It
can also generate a diff between two versions to help someone
see what has changed.
</para>
</section>
<section id="mysql">
<title>MySQL</title>
<caution>
<para>
MySQL's default configuration is very insecure.
<xref linkend="security-mysql"/> has some good information for
improving your installation's security.
</para>
</caution>
<section id="install-setupdatabase">
<title>Allow large attachments</title>
<para>
By default, MySQL will only accept packets up to 64Kb in size.
If you want to have attachments larger than this, you will need
to modify your <filename>/etc/my.cnf</filename> as below.
</para>
<screen> [mysqld]
# Allow packets up to 1M
max_allowed_packet=1M</screen>
<para>
There is also a parameter in Bugzilla called 'maxattachmentsize'
(default = 1000 Kb) that controls the maximum allowable attachment
size. Attachments larger than <emphasis>either</emphasis> the
'max_allowed_packet' or 'maxattachmentsize' value will not be
accepted by Bugzilla.
</para>
<note>
<para>
This does not affect Big Files, attachments that are stored directly
on disk instead of in the database. Their maximum size is
controlled using the 'maxlocalattachment' parameter.
</para>
</note>
</section>
<section>
<title>Allow small words in full-text indexes</title>
<para>By default, words must be at least four characters in length
in order to be indexed by MySQL's full-text indexes. This causes
a lot of Bugzilla specific words to be missed, including "cc",
"ftp" and "uri".</para>
<para>MySQL can be configured to index those words by setting the
ft_min_word_len param to the minimum size of the words to index.
This can be done by modifying the <filename>/etc/my.cnf</filename>
according to the example below:</para>
<screen> [mysqld]
# Allow small words in full-text indexes
ft_min_word_len=2</screen>
<para>Rebuilding the indexes can be done based on documentation found at
<ulink url="http://www.mysql.com/doc/en/Fulltext_Fine-tuning.html"/>.
</para>
</section>
<section id="install-setupdatabase-adduser">
<title>Add a user to MySQL</title>
<para>
You need to add a new MySQL user for Bugzilla to use.
(It's not safe to have Bugzilla use the MySQL root account.)
The following instructions assume the defaults in
<filename>localconfig</filename>; if you changed those,
you need to modify the SQL command appropriately. You will
need the <replaceable>$db_pass</replaceable> password you
set in <filename>localconfig</filename> in
<xref linkend="localconfig"/>.
</para>
<para>
We use an SQL <command>GRANT</command> command to create
a <quote>bugs</quote> user. This also restricts the
<quote>bugs</quote>user to operations within a database
called <quote>bugs</quote>, and only allows the account
to connect from <quote>localhost</quote>. Modify it to
reflect your setup if you will be connecting from another
machine or as a different user.
</para>
<para>
Run the <filename>mysql</filename> command-line client and enter:
</para>
<screen> <prompt>mysql&gt;</prompt> GRANT SELECT, INSERT,
UPDATE, DELETE, INDEX, ALTER, CREATE, LOCK TABLES,
CREATE TEMPORARY TABLES, DROP, REFERENCES ON bugs.*
TO bugs@localhost IDENTIFIED BY '<replaceable>$db_pass</replaceable>';
<prompt>mysql&gt;</prompt> FLUSH PRIVILEGES;</screen>
</section>
<section>
<title>Permit attachments table to grow beyond 4GB</title>
<para>
By default, MySQL will limit the size of a table to 4GB.
This limit is present even if the underlying filesystem
has no such limit. To set a higher limit, follow these
instructions.
</para>
<para>
After you have completed the rest of the installation (or at least the
database setup parts), you should run the <filename>MySQL</filename>
command-line client and enter the following, replacing <literal>$bugs_db</literal>
with your Bugzilla database name (<emphasis>bugs</emphasis> by default):
</para>
<screen>
<prompt>mysql&gt;</prompt> use <replaceable>$bugs_db</replaceable>
<prompt>mysql&gt;</prompt> ALTER TABLE attachments
AVG_ROW_LENGTH=1000000, MAX_ROWS=20000;
</screen>
<para>
The above command will change the limit to 20GB. Mysql will have
to make a temporary copy of your entire table to do this. Ideally,
you should do this when your attachments table is still small.
</para>
<note>
<para>
This does not affect Big Files, attachments that are stored directly
on disk instead of in the database.
</para>
</note>
</section>
</section>
<section id="postgresql">
<title>PostgreSQL</title>
<section>
<title>Add a User to PostgreSQL</title>
<para>You need to add a new user to PostgreSQL for the Bugzilla
application to use when accessing the database. The following instructions
assume the defaults in <filename>localconfig</filename>; if you
changed those, you need to modify the commands appropriately. You will
need the <replaceable>$db_pass</replaceable> password you
set in <filename>localconfig</filename> in
<xref linkend="localconfig"/>.</para>
<para>On most systems, to create the user in PostgreSQL, you will need to
login as the root user, and then</para>
<screen> <prompt>bash#</prompt> su - postgres</screen>
<para>As the postgres user, you then need to create a new user: </para>
<screen> <prompt>bash$</prompt> createuser -U postgres -dAP bugs</screen>
<para>When asked for a password, provide the password which will be set as
<replaceable>$db_pass</replaceable> in <filename>localconfig</filename>.
The created user will have the ability to create databases and will not be
able to create new users.</para>
</section>
<section>
<title>Configure PostgreSQL</title>
<para>Now, you will need to edit <filename>pg_hba.conf</filename> which is
usually located in <filename>/var/lib/pgsql/data/</filename>. In this file,
you will need to add a new line to it as follows:</para>
<para>
<computeroutput>host all bugs 127.0.0.1 255.255.255.255 md5</computeroutput>
</para>
<para>This means that for TCP/IP (host) connections, allow connections from
'127.0.0.1' to 'all' databases on this server from the 'bugs' user, and use
password authentication (md5) for that user.</para>
<para>Now, you will need to restart PostgreSQL, but you will need to fully
stop and start the server rather than just restarting due to the possibility
of a change to <filename>postgresql.conf</filename>. After the server has
restarted, you will need to edit <filename>localconfig</filename>, finding
the <literal>$db_driver</literal> variable and setting it to
<literal>Pg</literal> and changing the password in <literal>$db_pass</literal>
to the one you picked previously, while setting up the account.</para>
</section>
</section>
</section>
<section>
<title>checksetup.pl</title>
<para>
Next, rerun <filename>checksetup.pl</filename>. It reconfirms
that all the modules are present, and notices the altered
localconfig file, which it assumes you have edited to your
satisfaction. It compiles the UI templates,
connects to the database using the 'bugs'
user you created and the password you defined, and creates the
'bugs' database and the tables therein.
</para>
<para>
After that, it asks for details of an administrator account. Bugzilla
can have multiple administrators - you can create more later - but
it needs one to start off with.
Enter the email address of an administrator, his or her full name,
and a suitable Bugzilla password.
</para>
<para>
<filename>checksetup.pl</filename> will then finish. You may rerun
<filename>checksetup.pl</filename> at any time if you wish.
</para>
</section>
<section id="http">
<title>Web server</title>
<para>
Configure your web server according to the instructions in the
appropriate section. (If it makes a difference in your choice,
the Bugzilla Team recommends Apache.) To check whether your web server
is correctly configured, try to access <filename>testagent.cgi</filename>
from your web server. If "OK" is displayed, then your configuration
is successful. Regardless of which web server
you are using, however, ensure that sensitive information is
not remotely available by properly applying the access controls in
<xref linkend="security-webserver-access"/>. You can run
<filename>testserver.pl</filename> to check if your web server serves
Bugzilla files as expected.
</para>
<section id="http-apache">
<title>Bugzilla using Apache</title>
<para>You have two options for running Bugzilla under Apache -
<link linkend="http-apache-mod_cgi">mod_cgi</link> (the default) and
<link linkend="http-apache-mod_perl">mod_perl</link> (new in Bugzilla
2.23)
</para>
<section id="http-apache-mod_cgi">
<title>Apache <productname>httpd</productname> with mod_cgi</title>
<para>
To configure your Apache web server to work with Bugzilla while using
mod_cgi, do the following:
</para>
<procedure>
<step>
<para>
Load <filename>httpd.conf</filename> in your editor.
In Fedora and Red Hat Linux, this file is found in
<filename class="directory">/etc/httpd/conf</filename>.
</para>
</step>
<step>
<para>
Apache uses <computeroutput>&lt;Directory&gt;</computeroutput>
directives to permit fine-grained permission setting. Add the
following lines to a directive that applies to the location
of your Bugzilla installation. (If such a section does not
exist, you'll want to add one.) In this example, Bugzilla has
been installed at
<filename class="directory">/var/www/html/bugzilla</filename>.
</para>
<programlisting>
&lt;Directory /var/www/html/bugzilla&gt;
AddHandler cgi-script .cgi
Options +Indexes +ExecCGI
DirectoryIndex index.cgi
AllowOverride Limit
&lt;/Directory&gt;
</programlisting>
<para>
These instructions: allow apache to run .cgi files found
within the bugzilla directory; instructs the server to look
for a file called <filename>index.cgi</filename> if someone
only types the directory name into the browser; and allows
Bugzilla's <filename>.htaccess</filename> files to override
global permissions.
</para>
<note>
<para>
It is possible to make these changes globally, or to the
directive controlling Bugzilla's parent directory (e.g.
<computeroutput>&lt;Directory /var/www/html/&gt;</computeroutput>).
Such changes would also apply to the Bugzilla directory...
but they would also apply to many other places where they
may or may not be appropriate. In most cases, including
this one, it is better to be as restrictive as possible
when granting extra access.
</para>
</note>
</step>
<step>
<para>
<filename>checksetup.pl</filename> can set tighter permissions
on Bugzilla's files and directories if it knows what group the
web server runs as. Find the <computeroutput>Group</computeroutput>
line in <filename>httpd.conf</filename>, place the value found
there in the <replaceable>$webservergroup</replaceable> variable
in <filename>localconfig</filename>, then rerun
<filename>checksetup.pl</filename>.
</para>
</step>
<step>
<para>
Optional: If Bugzilla does not actually reside in the webspace
directory, but instead has been symbolically linked there, you
will need to add the following to the
<computeroutput>Options</computeroutput> line of the Bugzilla
<computeroutput>&lt;Directory&gt;</computeroutput> directive
(the same one as in the step above):
</para>
<programlisting>
+FollowSymLinks
</programlisting>
<para>
Without this directive, Apache will not follow symbolic links
to places outside its own directory structure, and you will be
unable to run Bugzilla.
</para>
</step>
</procedure>
</section>
<section id="http-apache-mod_perl">
<title>Apache <productname>httpd</productname> with mod_perl</title>
<para>Some configuration is required to make Bugzilla work with Apache
and mod_perl</para>
<procedure>
<step>
<para>
Load <filename>httpd.conf</filename> in your editor.
In Fedora and Red Hat Linux, this file is found in
<filename class="directory">/etc/httpd/conf</filename>.
</para>
</step>
<step>
<para>Add the following information to your httpd.conf file, substituting
where appropriate with your own local paths.</para>
<note>
<para>This should be used instead of the &lt;Directory&gt; block
shown above. This should also be above any other <literal>mod_perl</literal>
directives within the <filename>httpd.conf</filename> and must be specified
in the order as below.</para>
</note>
<warning>
<para>You should also ensure that you have disabled <literal>KeepAlive</literal>
support in your Apache install when utilizing Bugzilla under mod_perl</para>
</warning>
<programlisting>
PerlSwitches -I/var/www/html/bugzilla -I/var/www/html/bugzilla/lib -w -T
PerlConfigRequire /var/www/html/bugzilla/mod_perl.pl
</programlisting>
</step>
<step>
<para>
<filename>checksetup.pl</filename> can set tighter permissions
on Bugzilla's files and directories if it knows what group the
web server runs as. Find the <computeroutput>Group</computeroutput>
line in <filename>httpd.conf</filename>, place the value found
there in the <replaceable>$webservergroup</replaceable> variable
in <filename>localconfig</filename>, then rerun
<filename>checksetup.pl</filename>.
</para>
</step>
</procedure>
<para>On restarting Apache, Bugzilla should now be running within the
mod_perl environment. Please ensure you have run checksetup.pl to set
permissions before you restart Apache.</para>
<note>
<para>Please bear the following points in mind when looking at using
Bugzilla under mod_perl:
<itemizedlist>
<listitem>
<para>
mod_perl support in Bugzilla can take up a HUGE amount of RAM. You could be
looking at 30MB per httpd child, easily. Basically, you just need a lot of RAM.
The more RAM you can get, the better. mod_perl is basically trading RAM for
speed. At least 2GB total system RAM is recommended for running Bugzilla under
mod_perl.
</para>
</listitem>
<listitem>
<para>
Under mod_perl, you have to restart Apache if you make any manual change to
any Bugzilla file. You can't just reload--you have to actually
<emphasis>restart</emphasis> the server (as in make sure it stops and starts
again). You <emphasis>can</emphasis> change localconfig and the params file
manually, if you want, because those are re-read every time you load a page.
</para>
</listitem>
<listitem>
<para>
You must run in Apache's Prefork MPM (this is the default). The Worker MPM
may not work--we haven't tested Bugzilla's mod_perl support under threads.
(And, in fact, we're fairly sure it <emphasis>won't</emphasis> work.)
</para>
</listitem>
<listitem>
<para>
Bugzilla generally expects to be the only mod_perl application running on
your entire server. It may or may not work if there are other applications also
running under mod_perl. It does try its best to play nice with other mod_perl
applications, but it still may have conflicts.
</para>
</listitem>
<listitem>
<para>
It is recommended that you have one Bugzilla instance running under mod_perl
on your server. Bugzilla has not been tested with more than one instance running.
</para>
</listitem>
</itemizedlist>
</para>
</note>
</section>
</section>
<section id="http-iis">
<title>Microsoft <productname>Internet Information Services</productname></title>
<para>
If you are running Bugzilla on Windows and choose to use
Microsoft's <productname>Internet Information Services</productname>
or <productname>Personal Web Server</productname> you will need
to perform a number of other configuration steps as explained below.
You may also want to refer to the following Microsoft Knowledge
Base articles:
<ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;245225">245225</ulink>
<quote>HOW TO: Configure and Test a PERL Script with IIS 4.0,
5.0, and 5.1</quote> (for <productname>Internet Information
Services</productname>) and
<ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;231998">231998</ulink>
<quote>HOW TO: FP2000: How to Use Perl with Microsoft Personal Web
Server on Windows 95/98</quote> (for <productname>Personal Web
Server</productname>).
</para>
<para>
You will need to create a virtual directory for the Bugzilla
install. Put the Bugzilla files in a directory that is named
something <emphasis>other</emphasis> than what you want your
end-users accessing. That is, if you want your users to access
your Bugzilla installation through
<quote>http://&lt;yourdomainname&gt;/Bugzilla</quote>, then do
<emphasis>not</emphasis> put your Bugzilla files in a directory
named <quote>Bugzilla</quote>. Instead, place them in a different
location, and then use the IIS Administration tool to create a
Virtual Directory named "Bugzilla" that acts as an alias for the
actual location of the files. When creating that virtual directory,
make sure you add the <quote>Execute (such as ISAPI applications or
CGI)</quote> access permission.
</para>
<para>
You will also need to tell IIS how to handle Bugzilla's
.cgi files. Using the IIS Administration tool again, open up
the properties for the new virtual directory and select the
Configuration option to access the Script Mappings. Create an
entry mapping .cgi to:
</para>
<programlisting>
&lt;full path to perl.exe &gt;\perl.exe -x&lt;full path to Bugzilla&gt; -wT "%s" %s
</programlisting>
<para>
For example:
</para>
<programlisting>
c:\perl\bin\perl.exe -xc:\bugzilla -wT "%s" %s
</programlisting>
<note>
<para>
The ActiveState install may have already created an entry for
.pl files that is limited to <quote>GET,HEAD,POST</quote>. If
so, this mapping should be <emphasis>removed</emphasis> as
Bugzilla's .pl files are not designed to be run via a web server.
</para>
</note>
<para>
IIS will also need to know that the index.cgi should be treated
as a default document. On the Documents tab page of the virtual
directory properties, you need to add index.cgi as a default
document type. If you wish, you may remove the other default
document types for this particular virtual directory, since Bugzilla
doesn't use any of them.
</para>
<para>
Also, and this can't be stressed enough, make sure that files
such as <filename>localconfig</filename> and your
<filename class="directory">data</filename> directory are
secured as described in <xref linkend="security-webserver-access"/>.
</para>
</section>
</section>
<section id="install-config-bugzilla">
<title>Bugzilla</title>
<para>
Your Bugzilla should now be working. Access
<filename>http://&lt;your-bugzilla-server&gt;/</filename> -
you should see the Bugzilla
front page. If not, consult the Troubleshooting section,
<xref linkend="troubleshooting"/>.
</para>
<note>
<para>
The URL above may be incorrect if you installed Bugzilla into a
subdirectory or used a symbolic link from your web site root to
the Bugzilla directory.
</para>
</note>
<para>
Log in with the administrator account you defined in the last
<filename>checksetup.pl</filename> run. You should go through
the parameters on the Edit Parameters page
(see link in the footer) and see if there are any you wish to
change.
They key parameters are documented in <xref linkend="parameters"/>;
you should certainly alter
<command>maintainer</command> and <command>urlbase</command>;
you may also want to alter
<command>cookiepath</command> or <command>requirelogin</command>.
</para>
<para>
This would also be a good time to revisit the
<filename>localconfig</filename> file and make sure that the
names of the priorities, severities, platforms and operating systems
are those you wish to use when you start creating bugs. Remember
to rerun <filename>checksetup.pl</filename> if you change it.
</para>
<para>
Bugzilla has several optional features which require extra
configuration. You can read about those in
<xref linkend="extraconfig"/>.
</para>
</section>
</section>
<section id="extraconfig">
<title>Optional Additional Configuration</title>
<para>
Bugzilla has a number of optional features. This section describes how
to configure or enable them.
</para>
<section>
<title>Bug Graphs</title>
<para>If you have installed the necessary Perl modules you
can start collecting statistics for the nifty Bugzilla
graphs.</para>
<screen><prompt>bash#</prompt> <command>crontab -e</command></screen>
<para>
This should bring up the crontab file in your editor.
Add a cron entry like this to run
<filename>collectstats.pl</filename>
daily at 5 after midnight:
</para>
<programlisting>5 0 * * * cd &lt;your-bugzilla-directory&gt; ; ./collectstats.pl</programlisting>
<para>
After two days have passed you'll be able to view bug graphs from
the Reports page.
</para>
<para>
When upgrading Bugzilla, this format may change.
To create new status data, (re)move old data and run the following
commands:
</para>
<screen>
<prompt>bash$</prompt>
<command>cd &lt;your-bugzilla-directory&gt;</command>
<prompt>bash$</prompt>
<command>./collectstats.pl --regenerate</command>
</screen>
<note>
<para>
Windows does not have 'cron', but it does have the Task
Scheduler, which performs the same duties. There are also
third-party tools that can be used to implement cron, such as
<ulink url="http://www.nncron.ru/">nncron</ulink>.
</para>
</note>
</section>
<section id="installation-whining-cron">
<title>The Whining Cron</title>
<para>What good are
bugs if they're not annoying? To help make them more so you
can set up Bugzilla's automatic whining system to complain at engineers
which leave their bugs in the NEW or REOPENED state without triaging them.
</para>
<para>
This can be done by adding the following command as a daily
crontab entry, in the same manner as explained above for bug
graphs. This example runs it at 12.55am.
</para>
<programlisting>55 0 * * * cd &lt;your-bugzilla-directory&gt; ; ./whineatnews.pl</programlisting>
<note>
<para>
Windows does not have 'cron', but it does have the Task
Scheduler, which performs the same duties. There are also
third-party tools that can be used to implement cron, such as
<ulink url="http://www.nncron.ru/">nncron</ulink>.
</para>
</note>
</section>
<section id="installation-whining">
<title>Whining</title>
<para>
As of Bugzilla 2.20, users can configure Bugzilla to regularly annoy
them at regular intervals, by having Bugzilla execute saved searches
at certain times and emailing the results to the user. This is known
as "Whining". The process of configuring Whining is described
in <xref linkend="whining"/>, but for it to work a Perl script must be
executed at regular intervals.
</para>
<para>
This can be done by adding the following command as a daily
crontab entry, in the same manner as explained above for bug
graphs. This example runs it every 15 minutes.
</para>
<programlisting>*/15 * * * * cd &lt;your-bugzilla-directory&gt; ; ./whine.pl</programlisting>
<note>
<para>
Whines can be executed as often as every 15 minutes, so if you specify
longer intervals between executions of whine.pl, some users may not
be whined at as often as they would expect. Depending on the person,
this can either be a very Good Thing or a very Bad Thing.
</para>
</note>
<note>
<para>
Windows does not have 'cron', but it does have the Task
Scheduler, which performs the same duties. There are also
third-party tools that can be used to implement cron, such as
<ulink url="http://www.nncron.ru/">nncron</ulink>.
</para>
</note>
</section>
<section id="apache-addtype">
<title>Serving Alternate Formats with the right MIME type</title>
<para>
Some Bugzilla pages have alternate formats, other than just plain
<acronym>HTML</acronym>. In particular, a few Bugzilla pages can
output their contents as either <acronym>XUL</acronym> (a special
Mozilla format, that looks like a program <acronym>GUI</acronym>)
or <acronym>RDF</acronym> (a type of structured <acronym>XML</acronym>
that can be read by various programs).
</para>
<para>
In order for your users to see these pages correctly, Apache must
send them with the right <acronym>MIME</acronym> type. To do this,
add the following lines to your Apache configuration, either in the
<computeroutput>&lt;VirtualHost&gt;</computeroutput> section for your
Bugzilla, or in the <computeroutput>&lt;Directory&gt;</computeroutput>
section for your Bugzilla:
</para>
<para>
<screen>AddType application/vnd.mozilla.xul+xml .xul
AddType application/rdf+xml .rdf</screen>
</para>
</section>
</section>
<section id="multiple-bz-dbs">
<title>Multiple Bugzilla databases with a single installation</title>
<para>The previous instructions referred to a standard installation, with
one unique Bugzilla database. However, you may want to host several
distinct installations, without having several copies of the code. This is
possible by using the PROJECT environment variable. When accessed,
Bugzilla checks for the existence of this variable, and if present, uses
its value to check for an alternative configuration file named
<filename>localconfig.&lt;PROJECT&gt;</filename> in the same location as
the default one (<filename>localconfig</filename>). It also checks for
customized templates in a directory named
<filename>&lt;PROJECT&gt;</filename> in the same location as the
default one (<filename>template/&lt;langcode&gt;</filename>). By default
this is <filename>template/en/default</filename> so PROJECT's templates
would be located at <filename>template/en/PROJECT</filename>.</para>
<para>To set up an alternate installation, just export PROJECT=foo before
running <command>checksetup.pl</command> for the first time. It will
result in a file called <filename>localconfig.foo</filename> instead of
<filename>localconfig</filename>. Edit this file as described above, with
reference to a new database, and re-run <command>checksetup.pl</command>
to populate it. That's all.</para>
<para>Now you have to configure the web server to pass this environment
variable when accessed via an alternate URL, such as virtual host for
instance. The following is an example of how you could do it in Apache,
other Webservers may differ.
<programlisting>
&lt;VirtualHost 212.85.153.228:80&gt;
ServerName foo.bar.baz
SetEnv PROJECT foo
Alias /bugzilla /var/www/bugzilla
&lt;/VirtualHost&gt;
</programlisting>
</para>
<para>Don't forget to also export this variable before accessing Bugzilla
by other means, such as cron tasks for instance.</para>
</section>
<section id="os-specific">
<title>OS-Specific Installation Notes</title>
<para>Many aspects of the Bugzilla installation can be affected by the
operating system you choose to install it on. Sometimes it can be made
easier and others more difficult. This section will attempt to help you
understand both the difficulties of running on specific operating systems
and the utilities available to make it easier.
</para>
<para>If you have anything to add or notes for an operating system not
covered, please file a bug in &bzg-bugs;.
</para>
<section id="os-win32">
<title>Microsoft Windows</title>
<para>
Making Bugzilla work on Windows is more difficult than making it
work on Unix. For that reason, we still recommend doing so on a Unix
based system such as GNU/Linux. That said, if you do want to get
Bugzilla running on Windows, you will need to make the following
adjustments. A detailed step-by-step
<ulink url="http://www.bugzilla.org/docs/win32install.html">
installation guide for Windows</ulink> is also available
if you need more help with your installation.
</para>
<section id="win32-perl">
<title>Win32 Perl</title>
<para>
Perl for Windows can be obtained from
<ulink url="http://www.activestate.com/">ActiveState</ulink>.
You should be able to find a compiled binary at <ulink
url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/" />.
The following instructions assume that you are using version
5.8.1 of ActiveState.
</para>
<note>
<para>
These instructions are for 32-bit versions of Windows. If you are
using a 64-bit version of Windows, you will need to install 32-bit
Perl in order to install the 32-bit modules as described below.
</para>
</note>
</section>
<section id="win32-perl-modules">
<title>Perl Modules on Win32</title>
<para>
Bugzilla on Windows requires the same perl modules found in
<xref linkend="install-perlmodules"/>. The main difference is that
windows uses <glossterm linkend="gloss-ppm">PPM</glossterm> instead
of CPAN. ActiveState provides a GUI to manage Perl modules. We highly
recommend that you use it. If you prefer to use ppm from the
command-line, type:
</para>
<programlisting>
C:\perl&gt; <command>ppm install &lt;module name&gt;</command>
</programlisting>
<para>
The best source for the Windows PPM modules needed for Bugzilla
is probably the theory58S website, which you can add to your list
of repositories as follows (for Perl 5.8.x):
</para>
<programlisting>
<command>ppm repo add theory58S http://theoryx5.uwinnipeg.ca/ppms/</command>
</programlisting>
<para>
If you are using Perl 5.10.x, you cannot use the same PPM modules as Perl
5.8.x as they are incompatible. In this case, you should add the following
repository:
</para>
<programlisting>
<command>ppm repo add theory58S http://cpan.uwinnipeg.ca/PPMPackages/10xx/</command>
</programlisting>
<note>
<para>
In versions prior to 5.8.8 build 819 of PPM the command is
<programlisting>
<command>ppm repository add theory58S http://theoryx5.uwinnipeg.ca/ppms/</command>
</programlisting>
</para>
</note>
<note>
<para>
The PPM repository stores modules in 'packages' that may have
a slightly different name than the module. If retrieving these
modules from there, you will need to pay attention to the information
provided when you run <command>checksetup.pl</command> as it will
tell you what package you'll need to install.
</para>
</note>
<tip>
<para>
If you are behind a corporate firewall, you will need to let the
ActiveState PPM utility know how to get through it to access
the repositories by setting the HTTP_proxy system environmental
variable. For more information on setting that variable, see
the ActiveState documentation.
</para>
</tip>
</section>
<section id="win32-code-changes">
<title>Code changes required to run on Win32</title>
<para>
Bugzilla on Win32 is supported out of the box from version 2.20; this
means that no code changes are required to get Bugzilla running.
</para>
</section>
<section id="win32-http">
<title>Serving the web pages</title>
<para>
As is the case on Unix based systems, any web server should
be able to handle Bugzilla; however, the Bugzilla Team still
recommends Apache whenever asked. No matter what web server
you choose, be sure to pay attention to the security notes
in <xref linkend="security-webserver-access"/>. More
information on configuring specific web servers can be found
in <xref linkend="http"/>.
</para>
<note>
<para>
If using Apache on windows, you can set the <ulink
url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">ScriptInterpreterSource</ulink>
directive in your Apache config to avoid having to modify
the first line of every script to contain your path to Perl
instead of <filename>/usr/bin/perl</filename>. When setting
<filename>ScriptInterpreterSource</filename>, do not forget
to specify the <command>-T</command> flag to enable the taint
mode. For example: <command>C:\Perl\bin\perl.exe -T</command>.
</para>
</note>
</section>
<section id="win32-email">
<title>Sending Email</title>
<para>
To enable Bugzilla to send email on Windows, the server running the
Bugzilla code must be able to connect to, or act as, an SMTP server.
</para>
</section>
</section>
<section id="os-macosx">
<title><productname>Mac OS X</productname></title>
<para>Making Bugzilla work on Mac OS X requires the following
adjustments.</para>
<section id="macosx-sendmail">
<title>Sendmail</title>
<para>In Mac OS X 10.3 and later,
<ulink url="http://www.postfix.org/">Postfix</ulink>
is used as the built-in email server. Postfix provides an executable
that mimics sendmail enough to fool Bugzilla, as long as Bugzilla can
find it.</para>
<para>As of version 2.20, Bugzilla will be able to find the fake
sendmail executable without any assistance. However, you will have
to turn on the sendmailnow parameter before you do anything that would
result in email being sent. For more information, see the description
of the sendmailnow parameter in <xref linkend="parameters"/>.</para>
</section>
<section id="macosx-libraries">
<title>Libraries &amp; Perl Modules on Mac OS X</title>
<para>Apple does not include the GD library with Mac OS X. Bugzilla
needs this for bug graphs.</para>
<para>You can use DarwinPorts (<ulink url="http://darwinports.com/"/>)
or Fink (<ulink url="http://sourceforge.net/projects/fink/"/>), both
of which are similar in nature to the CPAN installer, but install
common unix programs.</para>
<para>Follow the instructions for setting up DarwinPorts or Fink.
Once you have one installed, you'll want to use it to install the
<filename>gd2</filename> package.
</para>
<para>Fink will prompt you for a number of dependencies, type 'y' and hit
enter to install all of the dependencies and then watch it work. You will
then be able to use <glossterm linkend="gloss-cpan">CPAN</glossterm> to
install the GD Perl module.
</para>
<note>
<para>To prevent creating conflicts with the software that Apple
installs by default, Fink creates its own directory tree at
<filename class="directory">/sw</filename> where it installs most of
the software that it installs. This means your libraries and headers
will be at <filename class="directory">/sw/lib</filename> and
<filename class="directory">/sw/include</filename> instead of
<filename class="directory">/usr/lib</filename> and
<filename class="directory">/usr/include</filename>. When the
Perl module config script asks where your <filename>libgd</filename>
is, be sure to tell it
<filename class="directory">/sw/lib</filename>.
</para>
</note>
<para>Also available via DarwinPorts and Fink is
<filename>expat</filename>. After installing the expat package, you
will be able to install XML::Parser using CPAN. If you use fink, there
is one caveat. Unlike recent versions of
the GD module, XML::Parser doesn't prompt for the location of the
required libraries. When using CPAN, you will need to use the following
command sequence:
</para>
<screen>
# perl -MCPAN -e'look XML::Parser' <co id="macosx-look"/>
# perl Makefile.PL EXPATLIBPATH=/sw/lib EXPATINCPATH=/sw/include
# make; make test; make install <co id="macosx-make"/>
# exit <co id="macosx-exit"/>
</screen>
<calloutlist>
<callout arearefs="macosx-look macosx-exit">
<para>The look command will download the module and spawn a
new shell with the extracted files as the current working directory.
The exit command will return you to your original shell.
</para>
</callout>
<callout arearefs="macosx-make">
<para>You should watch the output from these make commands,
especially <quote>make test</quote> as errors may prevent
XML::Parser from functioning correctly with Bugzilla.
</para>
</callout>
</calloutlist>
</section>
</section>
<section id="os-linux">
<title>Linux Distributions</title>
<para>Many Linux distributions include Bugzilla and its
dependencies in their native package management systems.
Installing Bugzilla with root access on any Linux system
should be as simple as finding the Bugzilla package in the
package management application and installing it using the
normal command syntax. Several distributions also perform
the proper web server configuration automatically on installation.
</para>
<para>Please consult the documentation of your Linux
distribution for instructions on how to install packages,
or for specific instructions on installing Bugzilla with
native package management tools. There is also a
<ulink url="http://wiki.mozilla.org/Bugzilla:Linux_Distro_Installation">
Bugzilla Wiki Page</ulink> for distro-specific installation
notes.
</para>
</section>
</section>
<section id="nonroot">
<title>UNIX (non-root) Installation Notes</title>
<section>
<title>Introduction</title>
<para>If you are running a *NIX OS as non-root, either due
to lack of access (web hosts, for example) or for security
reasons, this will detail how to install Bugzilla on such
a setup. It is recommended that you read through the
<xref linkend="installation" />
first to get an idea on the installation steps required.
(These notes will reference to steps in that guide.)</para>
</section>
<section>
<title>MySQL</title>
<para>You may have MySQL installed as root. If you're
setting up an account with a web host, a MySQL account
needs to be set up for you. From there, you can create
the bugs account, or use the account given to you.</para>
<warning>
<para>You may have problems trying to set up
<command>GRANT</command> permissions to the database.
If you're using a web host, chances are that you have a
separate database which is already locked down (or one big
database with limited/no access to the other areas), but you
may want to ask your system administrator what the security
settings are set to, and/or run the <command>GRANT</command>
command for you.</para>
<para>Also, you will probably not be able to change the MySQL
root user password (for obvious reasons), so skip that
step.</para>
</warning>
<section>
<title>Running MySQL as Non-Root</title>
<section>
<title>The Custom Configuration Method</title>
<para>Create a file .my.cnf in your
home directory (using /home/foo in this example)
as follows....</para>
<programlisting>
[mysqld]
datadir=/home/foo/mymysql
socket=/home/foo/mymysql/thesock
port=8081
[mysql]
socket=/home/foo/mymysql/thesock
port=8081
[mysql.server]
user=mysql
basedir=/var/lib
[safe_mysqld]
err-log=/home/foo/mymysql/the.log
pid-file=/home/foo/mymysql/the.pid
</programlisting>
</section>
<section>
<title>The Custom Built Method</title>
<para>You can install MySQL as a not-root, if you really need to.
Build it with PREFIX set to <filename class="directory">/home/foo/mysql</filename>,
or use pre-installed executables, specifying that you want
to put all of the data files in <filename class="directory">/home/foo/mysql/data</filename>.
If there is another MySQL server running on the system that you
do not own, use the -P option to specify a TCP port that is not
in use.</para>
</section>
<section>
<title>Starting the Server</title>
<para>After your mysqld program is built and any .my.cnf file is
in place, you must initialize the databases (ONCE).</para>
<screen>
<prompt>bash$</prompt>
<command>mysql_install_db</command>
</screen>
<para>Then start the daemon with</para>
<screen>
<prompt>bash$</prompt>
<command>safe_mysql &amp;</command>
</screen>
<para>After you start mysqld the first time, you then connect to
it as "root" and <command>GRANT</command> permissions to other
users. (Again, the MySQL root account has nothing to do with
the *NIX root account.)</para>
<note>
<para>You will need to start the daemons yourself. You can either
ask your system administrator to add them to system startup files, or
add a crontab entry that runs a script to check on these daemons
and restart them if needed.</para>
</note>
<warning>
<para>Do NOT run daemons or other services on a server without first
consulting your system administrator! Daemons use up system resources
and running one may be in violation of your terms of service for any
machine on which you are a user!</para>
</warning>
</section>
</section>
</section>
<section>
<title>Perl</title>
<para>
On the extremely rare chance that you don't have Perl on
the machine, you will have to build the sources
yourself. The following commands should get your system
installed with your own personal version of Perl:
</para>
<screen>
<prompt>bash$</prompt>
<command>wget http://perl.com/CPAN/src/stable.tar.gz</command>
<prompt>bash$</prompt>
<command>tar zvxf stable.tar.gz</command>
<prompt>bash$</prompt>
<command>cd perl-5.8.1</command> (or whatever the version of Perl is called)
<prompt>bash$</prompt>
<command>sh Configure -de -Dprefix=/home/foo/perl</command>
<prompt>bash$</prompt>
<command>make &amp;&amp; make test &amp;&amp; make install</command>
</screen>
<para>
Once you have Perl installed into a directory (probably
in <filename class="directory">~/perl/bin</filename>), you will need to
install the Perl Modules, described below.
</para>
</section>
<section id="install-perlmodules-nonroot">
<title>Perl Modules</title>
<para>
Installing the Perl modules as a non-root user is accomplished by
running the <filename>install-module.pl</filename>
script. For more details on this script, see
<ulink url="api/install-module.html"><filename>install-module.pl</filename>
documentation</ulink>
</para>
</section>
<section>
<title>HTTP Server</title>
<para>Ideally, this also needs to be installed as root and
run under a special web server account. As long as
the web server will allow the running of *.cgi files outside of a
cgi-bin, and a way of denying web access to certain files (such as a
.htaccess file), you should be good in this department.</para>
<section>
<title>Running Apache as Non-Root</title>
<para>You can run Apache as a non-root user, but the port will need
to be set to one above 1024. If you type <command>httpd -V</command>,
you will get a list of the variables that your system copy of httpd
uses. One of those, namely HTTPD_ROOT, tells you where that
installation looks for its config information.</para>
<para>From there, you can copy the config files to your own home
directory to start editing. When you edit those and then use the -d
option to override the HTTPD_ROOT compiled into the web server, you
get control of your own customized web server.</para>
<note>
<para>You will need to start the daemons yourself. You can either
ask your system administrator to add them to system startup files, or
add a crontab entry that runs a script to check on these daemons
and restart them if needed.</para>
</note>
<warning>
<para>Do NOT run daemons or other services on a server without first
consulting your system administrator! Daemons use up system resources
and running one may be in violation of your terms of service for any
machine on which you are a user!</para>
</warning>
</section>
</section>
<section>
<title>Bugzilla</title>
<para>
When you run <command>./checksetup.pl</command> to create
the <filename>localconfig</filename> file, it will list the Perl
modules it finds. If one is missing, go back and double-check the
module installation from <xref linkend="install-perlmodules-nonroot"/>,
then delete the <filename>localconfig</filename> file and try again.
</para>
<warning>
<para>One option in <filename>localconfig</filename> you
might have problems with is the web server group. If you can't
successfully browse to the <filename>index.cgi</filename> (like
a Forbidden error), you may have to relax your permissions,
and blank out the web server group. Of course, this may pose
as a security risk. Having a properly jailed shell and/or
limited access to shell accounts may lessen the security risk,
but use at your own risk.</para>
</warning>
<section id="suexec">
<title>suexec or shared hosting</title>
<para>If you are running on a system that uses suexec (most shared
hosting environments do this), you will need to set the
<emphasis>webservergroup</emphasis> value in <filename>localconfig</filename>
to match <emphasis>your</emphasis> primary group, rather than the one
the web server runs under. You will need to run the following
shell commands after running <command>./checksetup.pl</command>,
every time you run it (or modify <filename>checksetup.pl</filename>
to do them for you via the system() command).
<programlisting> for i in docs graphs images js skins; do find $i -type d -exec chmod o+rx {} \; ; done
for i in jpg gif css js png html rdf xul; do find . -name \*.$i -exec chmod o+r {} \; ; done
find . -name .htaccess -exec chmod o+r {} \;
chmod o+x . data data/webdot</programlisting>
Pay particular attention to the number of semicolons and dots.
They are all important. A future version of Bugzilla will
hopefully be able to do this for you out of the box.</para>
</section>
</section>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<!-- Keep these tools listings in alphabetical order please. -MPB -->
<section id="integration">
<title>Integrating Bugzilla with Third-Party Tools</title>
<section id="bonsai"
xreflabel="Bonsai, the Mozilla automated CVS management system">
<title>Bonsai</title>
<para>Bonsai is a web-based tool for managing
<xref linkend="cvs" />
. Using Bonsai, administrators can control open/closed status of trees,
query a fast relational database back-end for change, branch, and comment
information, and view changes made since the last time the tree was
closed. Bonsai
also integrates with
<xref linkend="tinderbox" />.
</para>
</section>
<section id="cvs" xreflabel="CVS, the Concurrent Versioning System">
<title>CVS</title>
<para>CVS integration is best accomplished, at this point, using the
Bugzilla Email Gateway.</para>
<para>Follow the instructions in this Guide for enabling Bugzilla e-mail
integration. Ensure that your check-in script sends an email to your
Bugzilla e-mail gateway with the subject of
<quote>[Bug XXXX]</quote>,
and you can have CVS check-in comments append to your Bugzilla bug. If
you want to have the bug be closed automatically, you'll have to modify
the <filename>contrib/bugzilla_email_append.pl</filename> script.
</para>
<para>There is also a CVSZilla project, based upon somewhat dated
Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at: <ulink url="http://www.cvszilla.org/"/>.
</para>
<para>Another system capable of CVS integration with Bugzilla is
Scmbug. This system provides generic integration of Source code
Configuration Management with Bugtracking. Check it out at: <ulink
url="http://freshmeat.net/projects/scmbug/"/>.
</para>
</section>
<section id="scm"
xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
<title>Perforce SCM</title>
<para>You can find the project page for Bugzilla and Teamtrack Perforce
integration (p4dti) at:
<ulink url="http://www.ravenbrook.com/project/p4dti/"/>
.
<quote>p4dti</quote>
is now an officially supported product from Perforce, and you can find
the "Perforce Public Depot" p4dti page at
<ulink url="http://public.perforce.com/public/perforce/p4dti/index.html"/>
.</para>
<para>Integration of Perforce with Bugzilla, once patches are applied, is
seamless. Perforce replication information will appear below the comments
of each bug. Be certain you have a matching set of patches for the
Bugzilla version you are installing. p4dti is designed to support
multiple defect trackers, and maintains its own documentation for it.
Please consult the pages linked above for further information.</para>
</section>
<section id="svn"
xreflabel="Subversion, a compelling replacement for CVS">
<title>Subversion</title>
<para>Subversion is a free/open-source version control system,
designed to overcome various limitations of CVS. Integration of
Subversion with Bugzilla is possible using Scmbug, a system
providing generic integration of Source Code Configuration
Management with Bugtracking. Scmbug is available at <ulink
url="http://freshmeat.net/projects/scmbug/"/>.</para>
</section>
<section id="tinderbox"
xreflabel="Tinderbox, the Mozilla automated build management system">
<title>Tinderbox/Tinderbox2</title>
<para>Tinderbox is a continuous-build system which can integrate with
Bugzilla - see
<ulink url="http://www.mozilla.org/projects/tinderbox"/> for details
of Tinderbox, and
<ulink url="http://tinderbox.mozilla.org/showbuilds.cgi"/> to see it
in action.</para>
</section>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<chapter id="introduction">
<title>Introduction</title>
<section id="what-is-bugzilla">
<title>What is Bugzilla?</title>
<para>
Bugzilla is a bug- or issue-tracking system. Bug-tracking
systems allow individual or groups of developers effectively to keep track
of outstanding problems with their products.
</para>
<para><emphasis>Do we need more here?</emphasis></para>
</section>
<section id="why-tracking">
<title>Why use a bug-tracking system?</title>
<para>Those who do not use a bug-tracking system tend to rely on
shared lists, email, spreadsheets and/or Post-It notes to monitor the
status of defects. This procedure
is usually error-prone and tends to cause those bugs judged least
significant by developers to be dropped or ignored.</para>
<para>Integrated defect-tracking systems make sure that nothing gets
swept under the carpet; they provide a method of creating, storing,
arranging and processing defect reports and enhancement requests.</para>
</section>
<section id="why-bugzilla">
<title>Why use Bugzilla?</title>
<para>Bugzilla is the leading open-source/free software bug tracking
system. It boasts many advanced features, including:
<itemizedlist>
<listitem>
<para>Powerful searching</para>
</listitem>
<listitem>
<para>User-configurable email notifications of bug changes</para>
</listitem>
<listitem>
<para>Full change history</para>
</listitem>
<listitem>
<para>Inter-bug dependency tracking and graphing</para>
</listitem>
<listitem>
<para>Excellent attachment management</para>
</listitem>
<listitem>
<para>Integrated, product-based, granular security schema</para>
</listitem>
<listitem>
<para>Fully security-audited, and runs under Perl's taint mode</para>
</listitem>
<listitem>
<para>A robust, stable RDBMS back-end</para>
</listitem>
<listitem>
<para>Completely customizable and/or localizable web user
interface</para>
</listitem>
<listitem>
<para>Additional XML, email and console interfaces</para>
</listitem>
<listitem>
<para>Extensive configurability</para>
</listitem>
<listitem>
<para>Smooth upgrade pathway between versions</para>
</listitem>
</itemizedlist>
</para>
<para>Bugzilla is very adaptable to various situations. Known uses
currently include IT support queues, Systems Administration deployment
management, chip design and development problem tracking (both
pre-and-post fabrication), and software and hardware bug tracking for
luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems.
Combined with systems such as
<ulink url="http://www.cvshome.org">CVS</ulink>,
<ulink url="http://www.mozilla.org/bonsai.html">Bonsai</ulink>, or
<ulink url="http://www.perforce.com">Perforce SCM</ulink>, Bugzilla
provides a powerful, easy-to-use configuration management solution.</para>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="install-perlmodules-manual">
<title>Manual Installation of Perl Modules</title>
<section id="modules-manual-instructions">
<title>Instructions</title>
<para>
If you need to install Perl modules manually, here's how it's done.
Download the module using the link given in the next section, and then
apply this magic incantation, as root:
</para>
<para>
<screen><prompt>bash#</prompt> tar -xzvf &lt;module&gt;.tar.gz
<prompt>bash#</prompt> cd &lt;module&gt;
<prompt>bash#</prompt> perl Makefile.PL
<prompt>bash#</prompt> make
<prompt>bash#</prompt> make test
<prompt>bash#</prompt> make install</screen>
</para>
<note>
<para>
In order to compile source code under Windows you will need to obtain
a 'make' utility. The <command>nmake</command> utility provided with
Microsoft Visual C++ may be used. As an alternative, there is a
utility called <command>dmake</command> available from CPAN which is
written entirely in Perl.
</para>
<para>
As described in <xref linkend="modules-manual-download" />, however, most
packages already exist and are available from ActiveState or theory58S.
We highly recommend that you install them using the ppm GUI available with
ActiveState and to add the theory58S repository to your list of repositories.
</para>
</note>
</section>
<section id="modules-manual-download">
<title>Download Locations</title>
<note>
<para>
Running Bugzilla on Windows requires the use of ActiveState
Perl 5.8.1 or higher. Many modules already exist in the core
distribution of ActiveState Perl. Additional modules can be downloaded
from <ulink url="http://theoryx5.uwinnipeg.ca/ppms/" /> if you use
Perl 5.8.x or from <ulink url="http://cpan.uwinnipeg.ca/PPMPackages/10xx/" />
if you use Perl 5.10.x.
</para>
</note>
<para>
CGI:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/CGI.pm/"/>
Documentation: <ulink url="http://perldoc.perl.org/CGI.html"/>
</literallayout>
</para>
<para>
Data-Dumper:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Data-Dumper/"/>
Documentation: <ulink url="http://search.cpan.org/dist/Data-Dumper/Dumper.pm"/>
</literallayout>
</para>
<para>
Date::Format (part of TimeDate):
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/TimeDate/"/>
Documentation: <ulink url="http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm"/>
</literallayout>
</para>
<para>
DBI:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBI/"/>
Documentation: <ulink url="http://dbi.perl.org/docs/"/>
</literallayout>
</para>
<para>
DBD::mysql:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBD-mysql/"/>
Documentation: <ulink url="http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm"/>
</literallayout>
</para>
<para>
DBD::Pg:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/DBD-Pg/"/>
Documentation: <ulink url="http://search.cpan.org/dist/DBD-Pg/Pg.pm"/>
</literallayout>
</para>
<para>
File::Spec:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/File-Spec/"/>
Documentation: <ulink url="http://perldoc.perl.org/File/Spec.html"/>
</literallayout>
</para>
<para>
Template-Toolkit:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Template-Toolkit/"/>
Documentation: <ulink url="http://www.template-toolkit.org/docs.html"/>
</literallayout>
</para>
<para>
GD:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GD/"/>
Documentation: <ulink url="http://search.cpan.org/dist/GD/GD.pm"/>
</literallayout>
</para>
<para>
Template::Plugin::GD:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Template-GD/" />
Documentation: <ulink url="http://www.template-toolkit.org/docs/aqua/Modules/index.html" />
</literallayout>
</para>
<para>
MIME::Parser (part of MIME-tools):
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/MIME-tools/"/>
Documentation: <ulink url="http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm"/>
</literallayout>
</para>
</section>
<section id="modules-manual-optional">
<title>Optional Modules</title>
<para>
Chart::Base:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Chart/"/>
Documentation: <ulink url="http://search.cpan.org/dist/Chart/Chart.pod"/>
</literallayout>
</para>
<para>
GD::Graph:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GDGraph/"/>
Documentation: <ulink url="http://search.cpan.org/dist/GDGraph/Graph.pm"/>
</literallayout>
</para>
<para>
GD::Text::Align (part of GD::Text::Util):
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/GDTextUtil/"/>
Documentation: <ulink url="http://search.cpan.org/dist/GDTextUtil/Text/Align.pm"/>
</literallayout>
</para>
<para>
XML::Twig:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/XML-Twig/"/>
Documentation: <ulink url="http://standards.ieee.org/resources/spasystem/twig/twig_stable.html"/>
</literallayout>
</para>
<para>
PatchReader:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/author/JKEISER/PatchReader/"/>
Documentation: <ulink url="http://www.johnkeiser.com/mozilla/Patch_Viewer.html"/>
</literallayout>
</para>
<para>
Image::Magick:
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/PerlMagick/"/>
Documentation: <ulink url="http://www.imagemagick.org/script/resources.php"/>
</literallayout>
</para>
</section>
</appendix>
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
<title>Contrib</title>
<para>
There are a number of unofficial Bugzilla add-ons in the
<filename class="directory">$BUGZILLA_ROOT/contrib/</filename>
directory. This section documents them.
</para>
<section id="cmdline">
<title>Command-line Search Interface</title>
<para>
There are a suite of Unix utilities for searching Bugzilla from the
command line. They live in the
<filename class="directory">contrib/cmdline</filename> directory.
There are three files - <filename>query.conf</filename>,
<filename>buglist</filename> and <filename>bugs</filename>.
</para>
<warning>
<para>
These files pre-date the templatization work done as part of the
2.16 release, and have not been updated.
</para>
</warning>
<para>
<filename>query.conf</filename> contains the mapping from
options to field names and comparison types. Quoted option names
are <quote>grepped</quote> for, so it should be easy to edit this
file. Comments (#) have no effect; you must make sure these lines
do not contain any quoted <quote>option</quote>.
</para>
<para>
<filename>buglist</filename> is a shell script that submits a
Bugzilla query and writes the resulting HTML page to stdout.
It supports both short options, (such as <quote>-Afoo</quote>
or <quote>-Rbar</quote>) and long options (such
as <quote>--assignedto=foo</quote> or <quote>--reporter=bar</quote>).
If the first character of an option is not <quote>-</quote>, it is
treated as if it were prefixed with <quote>--default=</quote>.
</para>
<para>
The column list is taken from the COLUMNLIST environment variable.
This is equivalent to the <quote>Change Columns</quote> option
that is available when you list bugs in buglist.cgi. If you have
already used Bugzilla, grep for COLUMNLIST in your cookies file
to see your current COLUMNLIST setting.
</para>
<para>
<filename>bugs</filename> is a simple shell script which calls
<filename>buglist</filename> and extracts the
bug numbers from the output. Adding the prefix
<quote>http://bugzilla.mozilla.org/buglist.cgi?bug_id=</quote>
turns the bug list into a working link if any bugs are found.
Counting bugs is easy. Pipe the results through
<command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
</para>
<para>
Akkana Peck says she has good results piping
<filename>buglist</filename> output through
<command>w3m -T text/html -dump</command>
</para>
</section>
<section id="cmdline-bugmail">
<title>Command-line 'Send Unsent Bug-mail' tool</title>
<para>
Within the <filename class="directory">contrib</filename> directory
exists a utility with the descriptive (if compact) name
of <filename>sendunsentbugmail.pl</filename>. The purpose of this
script is, simply, to send out any bug-related mail that should
have been sent by now, but for one reason or another has not.
</para>
<para>
To accomplish this task, <filename>sendunsentbugmail.pl</filename> uses
the same mechanism as the <filename>sanitycheck.cgi</filename> script;
it scans through the entire database looking for bugs with changes that
were made more than 30 minutes ago, but where there is no record of
anyone related to that bug having been sent mail. Having compiled a list,
it then uses the standard rules to determine who gets mail, and sends it
out.
</para>
<para>
As the script runs, it indicates the bug for which it is currently
sending mail; when it has finished, it gives a numerical count of how
many mails were sent and how many people were excluded. (Individual
user names are not recorded or displayed.) If the script produces
no output, that means no unsent mail was detected.
</para>
<para>
<emphasis>Usage</emphasis>: move the sendunsentbugmail.pl script
up into the main directory, ensure it has execute permission, and run it
from the command line (or from a cron job) with no parameters.
</para>
</section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="downloadlinks">
<title>Software Download Links</title>
<para>All of these sites are current as of April, 2001. Hopefully they'll
stay current for a while.</para>
<para>Apache Web Server:
<ulink url="http://www.apache.org/"/>
Optional web server for Bugzilla, but recommended because of broad user
base and support.</para>
<para>Bugzilla:
<ulink url="http://www.bugzilla.org/"/>
</para>
<para>MySQL:
<ulink url="http://www.mysql.com/"/>
</para>
<para>Perl:
<ulink url="http://www.perl.org/"/>
</para>
<para>CPAN:
<ulink url="http://www.cpan.org/"/>
</para>
<para>DBI Perl module:
<ulink url="http://www.cpan.org/modules/by-module/DBI/"/>
</para>
<para>MySQL related Perl modules:
<ulink url="http://www.cpan.org/modules/by-module/Mysql/"/>
</para>
<para>TimeDate Perl module collection:
<ulink url="http://www.cpan.org/modules/by-module/Date/"/>
</para>
<para>GD Perl module:
<ulink url="http://www.cpan.org/modules/by-module/GD/"/>
Alternately, you should be able to find the latest version of GD at
<ulink url="http://www.boutell.com/gd/"/>
</para>
<para>Chart::Base module:
<ulink url="http://www.cpan.org/modules/by-module/Chart/"/>
</para>
<para>(But remember, Bundle::Bugzilla will install all the modules for you.)
</para>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: security.xml,v 1.18 2007/09/03 10:12:04 lpsolit%gmail.com Exp $ -->
<chapter id="security">
<title>Bugzilla Security</title>
<para>While some of the items in this chapter are related to the operating
system Bugzilla is running on or some of the support software required to
run Bugzilla, it is all related to protecting your data. This is not
intended to be a comprehensive guide to securing Linux, Apache, MySQL, or
any other piece of software mentioned. There is no substitute for active
administration and monitoring of a machine. The key to good security is
actually right in the middle of the word: <emphasis>U R It</emphasis>.
</para>
<para>While programmers in general always strive to write secure code,
accidents can and do happen. The best approach to security is to always
assume that the program you are working with isn't 100% secure and restrict
its access to other parts of your machine as much as possible.
</para>
<section id="security-os">
<title>Operating System</title>
<section id="security-os-ports">
<title>TCP/IP Ports</title>
<!-- TODO: Get exact number of ports -->
<para>The TCP/IP standard defines more than 65,000 ports for sending
and receiving traffic. Of those, Bugzilla needs exactly one to operate
(different configurations and options may require up to 3). You should
audit your server and make sure that you aren't listening on any ports
you don't need to be. It's also highly recommended that the server
Bugzilla resides on, along with any other machines you administer, be
placed behind some kind of firewall.
</para>
</section>
<section id="security-os-accounts">
<title>System User Accounts</title>
<para>Many <glossterm linkend="gloss-daemon">daemons</glossterm>, such
as Apache's <filename>httpd</filename> or MySQL's
<filename>mysqld</filename>, run as either <quote>root</quote> or
<quote>nobody</quote>. This is even worse on Windows machines where the
majority of <glossterm linkend="gloss-service">services</glossterm>
run as <quote>SYSTEM</quote>. While running as <quote>root</quote> or
<quote>SYSTEM</quote> introduces obvious security concerns, the
problems introduced by running everything as <quote>nobody</quote> may
not be so obvious. Basically, if you run every daemon as
<quote>nobody</quote> and one of them gets compromised it can
compromise every other daemon running as <quote>nobody</quote> on your
machine. For this reason, it is recommended that you create a user
account for each daemon.
</para>
<note>
<para>You will need to set the <option>webservergroup</option> option
in <filename>localconfig</filename> to the group your web server runs
as. This will allow <filename>./checksetup.pl</filename> to set file
permissions on Unix systems so that nothing is world-writable.
</para>
</note>
</section>
<section id="security-os-chroot">
<title>The <filename>chroot</filename> Jail</title>
<para>
If your system supports it, you may wish to consider running
Bugzilla inside of a <filename>chroot</filename> jail. This option
provides unprecedented security by restricting anything running
inside the jail from accessing any information outside of it. If you
wish to use this option, please consult the documentation that came
with your system.
</para>
</section>
</section>
<section id="security-mysql">
<title>MySQL</title>
<section id="security-mysql-account">
<title>The MySQL System Account</title>
<para>As mentioned in <xref linkend="security-os-accounts"/>, the MySQL
daemon should run as a non-privileged, unique user. Be sure to consult
the MySQL documentation or the documentation that came with your system
for instructions.
</para>
</section>
<section id="security-mysql-root">
<title>The MySQL <quote>root</quote> and <quote>anonymous</quote> Users</title>
<para>By default, MySQL comes with a <quote>root</quote> user with a
blank password and an <quote>anonymous</quote> user, also with a blank
password. In order to protect your data, the <quote>root</quote> user
should be given a password and the anonymous user should be disabled.
</para>
<example id="security-mysql-account-root">
<title>Assigning the MySQL <quote>root</quote> User a Password</title>
<screen>
<prompt>bash$</prompt> mysql mysql
<prompt>mysql&gt;</prompt> UPDATE user SET password = password('<replaceable>new_password</replaceable>') WHERE user = 'root';
<prompt>mysql&gt;</prompt> FLUSH PRIVILEGES;
</screen>
</example>
<example id="security-mysql-account-anonymous">
<title>Disabling the MySQL <quote>anonymous</quote> User</title>
<screen>
<prompt>bash$</prompt> mysql -u root -p mysql <co id="security-mysql-account-anonymous-mysql"/>
<prompt>Enter Password:</prompt> <replaceable>new_password</replaceable>
<prompt>mysql&gt;</prompt> DELETE FROM user WHERE user = '';
<prompt>mysql&gt;</prompt> FLUSH PRIVILEGES;
</screen>
<calloutlist>
<callout arearefs="security-mysql-account-anonymous-mysql">
<para>This command assumes that you have already completed
<xref linkend="security-mysql-account-root"/>.
</para>
</callout>
</calloutlist>
</example>
</section>
<section id="security-mysql-network">
<title>Network Access</title>
<para>If MySQL and your web server both run on the same machine and you
have no other reason to access MySQL remotely, then you should disable
the network access. This, along with the suggestion in
<xref linkend="security-os-ports"/>, will help protect your system from
any remote vulnerabilities in MySQL.
</para>
<example id="security-mysql-network-ex">
<title>Disabling Networking in MySQL</title>
<para>Simply enter the following in <filename>/etc/my.cnf</filename>:
<screen>
[mysqld]
# Prevent network access to MySQL.
skip-networking
</screen>
</para>
</example>
</section>
<!-- For possible addition in the future: How to better control the bugs user
<section id="security-mysql-bugs">
<title>The bugs User</title>
</section>
-->
</section>
<section id="security-webserver">
<title>Web server</title>
<section id="security-webserver-access">
<title>Disabling Remote Access to Bugzilla Configuration Files</title>
<para>
There are many files that are placed in the Bugzilla directory
area that should not be accessible from the web server. Because of the way
Bugzilla is currently layed out, the list of what should and should not
be accessible is rather complicated. A quick way is to run
<filename>testserver.pl</filename> to check if your web server serves
Bugzilla files as expected. If not, you may want to follow the few
steps below.
</para>
<tip>
<para>Bugzilla ships with the ability to create
<glossterm linkend="gloss-htaccess"><filename>.htaccess</filename></glossterm>
files that enforce these rules. Instructions for enabling these
directives in Apache can be found in <xref linkend="http-apache"/>
</para>
</tip>
<itemizedlist spacing="compact">
<listitem>
<para>In the main Bugzilla directory, you should:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Block:
<simplelist type="inline">
<member><filename>*.pl</filename></member>
<member><filename>*localconfig*</filename></member>
</simplelist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In <filename class="directory">data</filename>:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Block everything</para>
</listitem>
<listitem>
<para>But allow:
<simplelist type="inline">
<member><filename>duplicates.rdf</filename></member>
</simplelist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In <filename class="directory">data/webdot</filename>:</para>
<itemizedlist spacing="compact">
<listitem>
<para>If you use a remote webdot server:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Block everything</para>
</listitem>
<listitem>
<para>But allow
<simplelist type="inline">
<member><filename>*.dot</filename></member>
</simplelist>
only for the remote webdot server</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Otherwise, if you use a local GraphViz:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Block everything</para>
</listitem>
<listitem>
<para>But allow:
<simplelist type="inline">
<member><filename>*.png</filename></member>
<member><filename>*.gif</filename></member>
<member><filename>*.jpg</filename></member>
<member><filename>*.map</filename></member>
</simplelist>
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>And if you don't use any dot:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Block everything</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In <filename class="directory">Bugzilla</filename>:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Block everything</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>In <filename class="directory">template</filename>:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Block everything</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>Be sure to test that data that should not be accessed remotely is
properly blocked. Of particular interest is the localconfig file which
contains your database password. Also, be aware that many editors
create temporary and backup files in the working directory and that
those should also not be accessible. For more information, see
<ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=186383">bug 186383</ulink>
or
<ulink url="http://online.securityfocus.com/bid/6501">Bugtraq ID 6501</ulink>.
To test, simply run <filename>testserver.pl</filename>, as said above.
</para>
<tip>
<para>Be sure to check <xref linkend="http"/> for instructions
specific to the web server you use.
</para>
</tip>
</section>
</section>
<section id="security-bugzilla">
<title>Bugzilla</title>
<section id="security-bugzilla-charset">
<title>Prevent users injecting malicious Javascript</title>
<para>If you installed Bugzilla version 2.22 or later from scratch,
then the <emphasis>utf8</emphasis> parameter is switched on by default.
This makes Bugzilla explicitly set the character encoding, following
<ulink
url="http://www.cert.org/tech_tips/malicious_code_mitigation.html#3">a
CERT advisory</ulink> recommending exactly this.
The following therefore does not apply to you; just keep
<emphasis>utf8</emphasis> turned on.
</para>
<para>If you've upgraded from an older version, then it may be possible
for a Bugzilla user to take advantage of character set encoding
ambiguities to inject HTML into Bugzilla comments.
This could include malicious scripts.
This is because due to internationalization concerns, we are unable to
turn the <emphasis>utf8</emphasis> parameter on by default for upgraded
installations.
Turning it on manually will prevent this problem.
</para>
</section>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: -->
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: troubleshooting.xml,v 1.13 2007/07/24 18:22:02 timeless%mozdev.org Exp $ -->
<appendix id="troubleshooting">
<title>Troubleshooting</title>
<para>This section gives solutions to common Bugzilla installation
problems. If none of the section headings seems to match your
problem, read the general advice.
</para>
<section id="general-advice">
<title>General Advice</title>
<para>If you can't get <filename>checksetup.pl</filename> to run to
completion, it normally explains what's wrong and how to fix it.
If you can't work it out, or if it's being uncommunicative, post
the errors in the
<ulink url="news://news.mozilla.org/mozilla.support.bugzilla">mozilla.support.bugzilla</ulink>
newsgroup.
</para>
<para>If you have made it all the way through
<xref linkend="installation"/> (Installation) and
<xref linkend="configuration"/> (Configuration) but accessing the Bugzilla
URL doesn't work, the first thing to do is to check your web server error
log. For Apache, this is often located at
<filename>/etc/logs/httpd/error_log</filename>. The error messages
you see may be self-explanatory enough to enable you to diagnose and
fix the problem. If not, see below for some commonly-encountered
errors. If that doesn't help, post the errors to the newsgroup.
</para>
<para>
Bugzilla can also log all user-based errors (and many code-based errors)
that occur, without polluting the web server's error log. To enable
Bugzilla error logging, create a file that Bugzilla can write to, named
<filename>errorlog</filename>, in the Bugzilla <filename>data</filename>
directory. Errors will be logged as they occur, and will include the type
of the error, the IP address and username (if available) of the user who
triggered the error, and the values of all environment variables; if a
form was being submitted, the data in the form will also be included.
To disable error logging, delete or rename the
<filename>errorlog</filename> file.
</para>
</section>
<section id="trbl-testserver">
<title>The Apache web server is not serving Bugzilla pages</title>
<para>After you have run <command>checksetup.pl</command> twice,
run <command>testserver.pl http://yoursite.yourdomain/yoururl</command>
to confirm that your web server is configured properly for
Bugzilla.
</para>
<programlisting>
<prompt>bash$</prompt> ./testserver.pl http://landfill.bugzilla.org/bugzilla-tip
TEST-OK Webserver is running under group id in $webservergroup.
TEST-OK Got ant picture.
TEST-OK Webserver is executing CGIs.
TEST-OK Webserver is preventing fetch of http://landfill.bugzilla.org/bugzilla-tip/localconfig.
</programlisting>
</section>
<section id="trbl-perlmodule">
<title>I installed a Perl module, but
<filename>checksetup.pl</filename> claims it's not installed!</title>
<para>This could be caused by one of two things:</para>
<orderedlist>
<listitem>
<para>You have two versions of Perl on your machine. You are installing
modules into one, and Bugzilla is using the other. Rerun the CPAN
commands (or manual compile) using the full path to Perl from the
top of <filename>checksetup.pl</filename>. This will make sure you
are installing the modules in the right place.
</para>
</listitem>
<listitem>
<para>The permissions on your library directories are set incorrectly.
They must, at the very least, be readable by the web server user or
group. It is recommended that they be world readable.
</para>
</listitem>
</orderedlist>
</section>
<section id="trbl-dbdSponge">
<title>DBD::Sponge::db prepare failed</title>
<para>The following error message may appear due to a bug in DBD::mysql
(over which the Bugzilla team have no control):
</para>
<programlisting><![CDATA[ DBD::Sponge::db prepare failed: Cannot determine NUM_OF_FIELDS at D:/Perl/site/lib/DBD/mysql.pm line 248.
SV = NULL(0x0) at 0x20fc444
REFCNT = 1
FLAGS = (PADBUSY,PADMY)
]]></programlisting>
<para>To fix this, go to
<filename>&lt;path-to-perl&gt;/lib/DBD/sponge.pm</filename>
in your Perl installation and replace
</para>
<programlisting><![CDATA[ my $numFields;
if ($attribs->{'NUM_OF_FIELDS'}) {
$numFields = $attribs->{'NUM_OF_FIELDS'};
} elsif ($attribs->{'NAME'}) {
$numFields = @{$attribs->{NAME}};
]]></programlisting>
<para>with</para>
<programlisting><![CDATA[ my $numFields;
if ($attribs->{'NUM_OF_FIELDS'}) {
$numFields = $attribs->{'NUM_OF_FIELDS'};
} elsif ($attribs->{'NAMES'}) {
$numFields = @{$attribs->{NAMES}};
]]></programlisting>
<para>(note the S added to NAME.)</para>
</section>
<section id="paranoid-security">
<title>cannot chdir(/var/spool/mqueue)</title>
<para>If you are installing Bugzilla on SuSE Linux, or some other
distributions with <quote>paranoid</quote> security options, it is
possible that the checksetup.pl script may fail with the error:
<programlisting><![CDATA[cannot chdir(/var/spool/mqueue): Permission denied
]]></programlisting>
</para>
<para>This is because your <filename>/var/spool/mqueue</filename>
directory has a mode of <computeroutput>drwx------</computeroutput>.
Type <command>chmod 755 <filename>/var/spool/mqueue</filename></command>
as root to fix this problem. This will allow any process running on your
machine the ability to <emphasis>read</emphasis> the
<filename>/var/spool/mqueue</filename> directory.
</para>
</section>
<section id="trbl-relogin-everyone">
<title>Everybody is constantly being forced to relogin</title>
<para>The most-likely cause is that the <quote>cookiepath</quote> parameter
is not set correctly in the Bugzilla configuration. You can change this (if
you're a Bugzilla administrator) from the editparams.cgi page via the web interface.
</para>
<para>The value of the cookiepath parameter should be the actual directory
containing your Bugzilla installation, <emphasis>as seen by the end-user's
web browser</emphasis>. Leading and trailing slashes are mandatory. You can
also set the cookiepath to any directory which is a parent of the Bugzilla
directory (such as '/', the root directory). But you can't put something
that isn't at least a partial match or it won't work. What you're actually
doing is restricting the end-user's browser to sending the cookies back only
to that directory.
</para>
<para>How do you know if you want your specific Bugzilla directory or the
whole site?
</para>
<para>If you have only one Bugzilla running on the server, and you don't
mind having other applications on the same server with it being able to see
the cookies (you might be doing this on purpose if you have other things on
your site that share authentication with Bugzilla), then you'll want to have
the cookiepath set to "/", or to a sufficiently-high enough directory that
all of the involved apps can see the cookies.
</para>
<example id="trbl-relogin-everyone-share">
<title>Examples of urlbase/cookiepath pairs for sharing login cookies</title>
<blockquote>
<literallayout>
urlbase is <ulink url="http://bugzilla.mozilla.org/"/>
cookiepath is /
urlbase is <ulink url="http://tools.mysite.tld/bugzilla/"/>
but you have http://tools.mysite.tld/someotherapp/ which shares
authentication with your Bugzilla
cookiepath is /
</literallayout>
</blockquote>
</example>
<para>On the other hand, if you have more than one Bugzilla running on the
server (some people do - we do on landfill) then you need to have the
cookiepath restricted enough so that the different Bugzillas don't
confuse their cookies with one another.
</para>
<example id="trbl-relogin-everyone-restrict">
<title>Examples of urlbase/cookiepath pairs to restrict the login cookie</title>
<blockquote>
<literallayout>
urlbase is <ulink url="http://landfill.bugzilla.org/bugzilla-tip/"/>
cookiepath is /bugzilla-tip/
urlbase is <ulink url="http://landfill.bugzilla.org/bugzilla-2.16-branch/"/>
cookiepath is /bugzilla-2.16-branch/
</literallayout>
</blockquote>
</example>
<para>If you had cookiepath set to <quote>/</quote> at any point in the
past and need to set it to something more restrictive
(i.e. <quote>/bugzilla/</quote>), you can safely do this without
requiring users to delete their Bugzilla-related cookies in their
browser (this is true starting with Bugzilla 2.18 and Bugzilla 2.16.5).
</para>
</section>
<section id="trbl-relogin-some">
<title>Some users are constantly being forced to relogin</title>
<para>First, make sure cookies are enabled in the user's browser.
</para>
<para>If that doesn't fix the problem, it may be that the user's ISP
implements a rotating proxy server. This causes the user's effective IP
address (the address which the Bugzilla server perceives him coming from)
to change periodically. Since Bugzilla cookies are tied to a specific IP
address, each time the effective address changes, the user will have to
log in again.
</para>
<para>If you are using 2.18 (or later), there is a
parameter called <quote>loginnetmask</quote>, which you can use to set
the number of bits of the user's IP address to require to be matched when
authenticating the cookies. If you set this to something less than 32,
then the user will be given a checkbox for <quote>Restrict this login to
my IP address</quote> on the login screen, which defaults to checked. If
they leave the box checked, Bugzilla will behave the same as it did
before, requiring an exact match on their IP address to remain logged in.
If they uncheck the box, then only the left side of their IP address (up
to the number of bits you specified in the parameter) has to match to
remain logged in.
</para>
</section>
<section id="trbl-index">
<title><filename>index.cgi</filename> doesn't show up unless specified in the URL</title>
<para>
You probably need to set up your web server in such a way that it
will serve the index.cgi page as an index page.
</para>
<para>
If you are using Apache, you can do this by adding
<filename>index.cgi</filename> to the end of the
<computeroutput>DirectoryIndex</computeroutput> line
as mentioned in <xref linkend="http-apache"/>.
</para>
</section>
<section id="trbl-passwd-encryption">
<title>
checksetup.pl reports "Client does not support authentication protocol
requested by server..."
</title>
<para>
This error is occurring because you are using the new password
encryption that comes with MySQL 4.1, while your
<filename>DBD::mysql</filename> module was compiled against an
older version of MySQL. If you recompile <filename>DBD::mysql</filename>
against the current MySQL libraries (or just obtain a newer version
of this module) then the error may go away.
</para>
<para>
If that does not fix the problem, or if you cannot recompile the
existing module (e.g. you're running Windows) and/or don't want to
replace it (e.g. you want to keep using a packaged version), then a
workaround is available from the MySQL docs:
<ulink url="http://dev.mysql.com/doc/mysql/en/Old_client.html"/>
</para>
</section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: -->
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<chapter id="using">
<title>Using Bugzilla</title>
<section id="using-intro">
<title>Introduction</title>
<para>This section contains information for end-users of Bugzilla. There
is a Bugzilla test installation, called
<ulink url="http://landfill.bugzilla.org/">Landfill</ulink>, which you are
welcome to play with (if it's up). However, not all of the Bugzilla
installations there will necessarily have all Bugzilla features enabled,
and different installations run different versions, so some things may not
quite work as this document describes.</para>
<para>
Frequently Asked Questions (FAQ) are available and answered on
<ulink url="http://wiki.mozilla.org/Bugzilla:FAQ">wiki.mozilla.org</ulink>.
They may cover some questions you have which are left unanswered.
</para>
</section>
<section id="myaccount">
<title>Create a Bugzilla Account</title>
<para>If you want to use Bugzilla, first you need to create an account.
Consult with the administrator responsible for your installation of
Bugzilla for the URL you should use to access it. If you're
test-driving Bugzilla, use this URL:
<ulink url="&landfillbase;"/>.
</para>
<orderedlist>
<listitem>
<para>
On the home page <filename>index.cgi</filename>, click the
<quote>Open a new Bugzilla account</quote> link, or the
<quote>New Account</quote> link available in the footer of pages.
Now enter your email address, then click the <quote>Send</quote>
button.
</para>
<note>
<para>
If none of these links is available, this means that the
administrator of the installation has disabled self-registration.
This means that only an administrator can create accounts
for other users. One reason could be that this installation is
private.
</para>
</note>
<note>
<para>
Also, if only some users are allowed to create an account on
the installation, you may see these links but your registration
may fail if your email address doesn't match the ones accepted
by the installation. This is another way to restrict who can
access and edit bugs in this installation.
</para>
</note>
</listitem>
<listitem>
<para>
Within moments, and if your registration is accepted, you should
receive an email to the address you provided, which contains your
login name (generally the same as the email address), and two URLs
with a token (a random string generated by the installation) to
confirm, respectively cancel, your registration. This is a way to
prevent users from abusing the generation of user accounts, for
instance by entering inexistent email addresses, or email addresses
which do not belong to them.
</para>
</listitem>
<listitem>
<para>
By default, you have 3 days to confirm your registration. Past this
timeframe, the token is invalidated and the registration is
automatically canceled. You can also cancel this registration sooner
by using the appropriate URL in the email you got.
</para>
</listitem>
<listitem>
<para>
If you confirm your registration, Bugzilla will ask you your real name
(optional, but recommended) and your password, which must be between
3 and 16 characters long.
</para>
</listitem>
<listitem>
<para>
Now all you need to do is to click the <quote>Log In</quote>
link in the footer at the bottom of the page in your browser,
enter your email address and password you just chose into the
login form, and click the <quote>Log in</quote> button.
</para>
</listitem>
</orderedlist>
<para>
You are now logged in. Bugzilla uses cookies to remember you are
logged in so, unless you have cookies disabled or your IP address changes,
you should not have to log in again during your session.
</para>
</section>
<section id="bug_page">
<title>Anatomy of a Bug</title>
<para>The core of Bugzilla is the screen which displays a particular
bug. It's a good place to explain some Bugzilla concepts.
<ulink
url="&landfillbase;show_bug.cgi?id=1">
Bug 1 on Landfill</ulink>
is a good example. Note that the labels for most fields are hyperlinks;
clicking them will take you to context-sensitive help on that
particular field. Fields marked * may not be present on every
installation of Bugzilla.</para>
<orderedlist>
<listitem>
<para>
<emphasis>Product and Component</emphasis>:
Bugs are divided up by Product and Component, with a Product
having one or more Components in it. For example,
bugzilla.mozilla.org's "Bugzilla" Product is composed of several
Components:
<simplelist>
<member>
<emphasis>Administration:</emphasis>
Administration of a Bugzilla installation.</member>
<member>
<emphasis>Bugzilla-General:</emphasis>
Anything that doesn't fit in the other components, or spans
multiple components.</member>
<member>
<emphasis>Creating/Changing Bugs:</emphasis>
Creating, changing, and viewing bugs.</member>
<member>
<emphasis>Documentation:</emphasis>
The Bugzilla documentation, including The Bugzilla Guide.</member>
<member>
<emphasis>Email:</emphasis>
Anything to do with email sent by Bugzilla.</member>
<member>
<emphasis>Installation:</emphasis>
The installation process of Bugzilla.</member>
<member>
<emphasis>Query/Buglist:</emphasis>
Anything to do with searching for bugs and viewing the
buglists.</member>
<member>
<emphasis>Reporting/Charting:</emphasis>
Getting reports from Bugzilla.</member>
<member>
<emphasis>User Accounts:</emphasis>
Anything about managing a user account from the user's perspective.
Saved queries, creating accounts, changing passwords, logging in,
etc.</member>
<member>
<emphasis>User Interface:</emphasis>
General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates,
etc.</member>
</simplelist>
</para>
</listitem>
<listitem>
<para>
<emphasis>Status and Resolution:</emphasis>
These define exactly what state the bug is in - from not even
being confirmed as a bug, through to being fixed and the fix
confirmed by Quality Assurance. The different possible values for
Status and Resolution on your installation should be documented in the
context-sensitive help for those items.</para>
</listitem>
<listitem>
<para>
<emphasis>Assigned To:</emphasis>
The person responsible for fixing the bug.</para>
</listitem>
<listitem>
<para>
<emphasis>*QA Contact:</emphasis>
The person responsible for quality assurance on this bug.</para>
</listitem>
<listitem>
<para>
<emphasis>*URL:</emphasis>
A URL associated with the bug, if any.</para>
</listitem>
<listitem>
<para>
<emphasis>Summary:</emphasis>
A one-sentence summary of the problem.</para>
</listitem>
<listitem>
<para>
<emphasis>*Status Whiteboard:</emphasis>
(a.k.a. Whiteboard) A free-form text area for adding short notes
and tags to a bug.</para>
</listitem>
<listitem>
<para>
<emphasis>*Keywords:</emphasis>
The administrator can define keywords which you can use to tag and
categorise bugs - e.g. The Mozilla Project has keywords like crash
and regression.</para>
</listitem>
<listitem>
<para>
<emphasis>Platform and OS:</emphasis>
These indicate the computing environment where the bug was
found.</para>
</listitem>
<listitem>
<para>
<emphasis>Version:</emphasis>
The "Version" field is usually used for versions of a product which
have been released, and is set to indicate which versions of a
Component have the particular problem the bug report is
about.</para>
</listitem>
<listitem>
<para>
<emphasis>Priority:</emphasis>
The bug assignee uses this field to prioritize his or her bugs.
It's a good idea not to change this on other people's bugs.</para>
</listitem>
<listitem>
<para>
<emphasis>Severity:</emphasis>
This indicates how severe the problem is - from blocker
("application unusable") to trivial ("minor cosmetic issue"). You
can also use this field to indicate whether a bug is an enhancement
request.</para>
</listitem>
<listitem>
<para>
<emphasis>*Target:</emphasis>
(a.k.a. Target Milestone) A future version by which the bug is to
be fixed. e.g. The Bugzilla Project's milestones for future
Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
restricted to numbers, thought - you can use any text strings, such
as dates.</para>
</listitem>
<listitem>
<para>
<emphasis>Reporter:</emphasis>
The person who filed the bug.</para>
</listitem>
<listitem>
<para>
<emphasis>CC list:</emphasis>
A list of people who get mail when the bug changes.</para>
</listitem>
<listitem>
<para>
<emphasis>*Time Tracking:</emphasis>
This form can be used for time tracking.
To use this feature, you have to be blessed group membership
specified by the <quote>timetrackinggroup</quote> parameter.
<simplelist>
<member>
<emphasis>Orig. Est.:</emphasis>
This field shows the original estimated time.</member>
<member>
<emphasis>Current Est.:</emphasis>
This field shows the current estimated time.
This number is calculated from <quote>Hours Worked</quote>
and <quote>Hours Left</quote>.</member>
<member>
<emphasis>Hours Worked:</emphasis>
This field shows the number of hours worked.</member>
<member>
<emphasis>Hours Left:</emphasis>
This field shows the <quote>Current Est.</quote> -
<quote>Hours Worked</quote>.
This value + <quote>Hours Worked</quote> will become the
new Current Est.</member>
<member>
<emphasis>%Complete:</emphasis>
This field shows what percentage of the task is complete.</member>
<member>
<emphasis>Gain:</emphasis>
This field shows the number of hours that the bug is ahead of the
<quote>Orig. Est.</quote>.</member>
<member>
<emphasis>Deadline:</emphasis>
This field shows the deadline for this bug.</member>
</simplelist>
</para>
</listitem>
<listitem>
<para>
<emphasis>Attachments:</emphasis>
You can attach files (e.g. testcases or patches) to bugs. If there
are any attachments, they are listed in this section. Attachments are
normally stored in the Bugzilla database, unless they are marked as
Big Files, which are stored directly on disk.
</para>
</listitem>
<listitem>
<para>
<emphasis>*Dependencies:</emphasis>
If this bug cannot be fixed unless other bugs are fixed (depends
on), or this bug stops other bugs being fixed (blocks), their
numbers are recorded here.</para>
</listitem>
<listitem>
<para>
<emphasis>*Votes:</emphasis>
Whether this bug has any votes.</para>
</listitem>
<listitem>
<para>
<emphasis>Additional Comments:</emphasis>
You can add your two cents to the bug discussion here, if you have
something worthwhile to say.</para>
</listitem>
</orderedlist>
</section>
<section id="lifecycle">
<title>Life Cycle of a Bug</title>
<para>
The life cycle, also known as work flow, of a bug is currently hardcoded
into Bugzilla. <xref linkend="lifecycle-image"/> contains a graphical
representation of this life cycle. If you wish to customize this image for
your site, the <ulink url="../images/bzLifecycle.xml">diagram file</ulink>
is available in <ulink url="http://www.gnome.org/projects/dia">Dia's</ulink>
native XML format.
</para>
<figure id="lifecycle-image">
<title>Lifecycle of a Bugzilla Bug</title>
<mediaobject>
<imageobject>
<imagedata fileref="../images/bzLifecycle.png" scale="66" />
</imageobject>
</mediaobject>
</figure>
</section>
<section id="query">
<title>Searching for Bugs</title>
<para>The Bugzilla Search page is the interface where you can find
any bug report, comment, or patch currently in the Bugzilla system. You
can play with it here:
<ulink url="&landfillbase;query.cgi"/>.</para>
<para>The Search page has controls for selecting different possible
values for all of the fields in a bug, as described above. For some
fields, multiple values can be selected. In those cases, Bugzilla
returns bugs where the content of the field matches any one of the selected
values. If none is selected, then the field can take any value.</para>
<para>
After a search is run, you can save it as a Saved Search, which
will appear in the page footer. If you are in the group defined
by the "querysharegroup" parameter, you may share your queries
with other users, see <xref linkend="savedsearches"/> for more details.
</para>
<section id="boolean">
<title>Boolean Charts</title>
<para>
Highly advanced querying is done using Boolean Charts.
</para>
<para>
The boolean charts further restrict the set of results
returned by a query. It is possible to search for bugs
based on elaborate combinations of criteria.
</para>
<para>
The simplest boolean searches have only one term. These searches
permit the selected left <emphasis>field</emphasis>
to be compared using a
selectable <emphasis>operator</emphasis> to a
specified <emphasis>value.</emphasis>
Using the "And," "Or," and "Add Another Boolean Chart" buttons,
additional terms can be included in the query, further
altering the list of bugs returned by the query.
</para>
<para>
There are three fields in each row of a boolean search.
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>Field:</emphasis>
the items being searched
</para>
</listitem>
<listitem>
<para>
<emphasis>Operator:</emphasis>
the comparison operator
</para>
</listitem>
<listitem>
<para>
<emphasis>Value:</emphasis>
the value to which the field is being compared
</para>
</listitem>
</itemizedlist>
<section id="pronouns">
<title>Pronoun Substitution</title>
<para>
Sometimes, a query needs to compare a user-related field
(such as ReportedBy) with a role-specific user (such as the
user running the query or the user to whom each bug is assigned).
When the operator is either "equals" or "notequals", the value
can be "%reporter%", "%assignee%", "%qacontact%", or "%user%".
The user pronoun
refers to the user who is executing the query or, in the case
of whining reports, the user who will be the recipient
of the report. The reporter, assignee, and qacontact
pronouns refer to the corresponding fields in the bug.
</para>
<para>
Boolean charts also let you type a group name in any user-related
field if the operator is either "equals", "notequals" or "anyexact".
This will let you query for any member belonging (or not) to the
specified group. The group name must be entered following the
"%group.foo%" syntax, where "foo" is the group name.
So if you are looking for bugs reported by any user being in the
"editbugs" group, then you can type "%group.editbugs%".
</para>
</section>
<section id="negation">
<title>Negation</title>
<para>
At first glance, negation seems redundant. Rather than
searching for
<blockquote>
<para>
NOT("summary" "contains the string" "foo"),
</para>
</blockquote>
one could search for
<blockquote>
<para>
("summary" "does not contain the string" "foo").
</para>
</blockquote>
However, the search
<blockquote>
<para>
("CC" "does not contain the string" "@mozilla.org")
</para>
</blockquote>
would find every bug where anyone on the CC list did not contain
"@mozilla.org" while
<blockquote>
<para>
NOT("CC" "contains the string" "@mozilla.org")
</para>
</blockquote>
would find every bug where there was nobody on the CC list who
did contain the string. Similarly, the use of negation also permits
complex expressions to be built using terms OR'd together and then
negated. Negation permits queries such as
<blockquote>
<para>
NOT(("product" "equals" "update") OR
("component" "equals" "Documentation"))
</para>
</blockquote>
to find bugs that are neither
in the update product or in the documentation component or
<blockquote>
<para>
NOT(("commenter" "equals" "%assignee%") OR
("component" "equals" "Documentation"))
</para>
</blockquote>
to find non-documentation
bugs on which the assignee has never commented.
</para>
</section>
<section id="multiplecharts">
<title>Multiple Charts</title>
<para>
The terms within a single row of a boolean chart are all
constraints on a single piece of data. If you are looking for
a bug that has two different people cc'd on it, then you need
to use two boolean charts. A search for
<blockquote>
<para>
("cc" "contains the string" "foo@") AND
("cc" "contains the string" "@mozilla.org")
</para>
</blockquote>
would return only bugs with "foo@mozilla.org" on the cc list.
If you wanted bugs where there is someone on the cc list
containing "foo@" and someone else containing "@mozilla.org",
then you would need two boolean charts.
<blockquote>
<para>
First chart: ("cc" "contains the string" "foo@")
</para>
<para>
Second chart: ("cc" "contains the string" "@mozilla.org")
</para>
</blockquote>
The bugs listed will be only the bugs where ALL the charts are true.
</para>
</section>
</section>
<section id="quicksearch">
<title>Quicksearch</title>
<para>
Quicksearch is a single-text-box query tool which uses
metacharacters to indicate what is to be searched. For example, typing
"<literal>foo|bar</literal>"
into Quicksearch would search for "foo" or "bar" in the
summary and status whiteboard of a bug; adding
"<literal>:BazProduct</literal>" would
search only in that product.
You can use it to find a bug by its number or its alias, too.
</para>
<para>
You'll find the Quicksearch box in Bugzilla's footer area.
On Bugzilla's front page, there is an additional
<ulink url="../../page.cgi?id=quicksearch.html">Help</ulink>
link which details how to use it.
</para>
</section>
<section id="casesensitivity">
<title>Case Sensitivity in Searches</title>
<para>
Bugzilla queries are case-insensitive and accent-insensitive, when
used with either MySQL or Oracle databases. When using Bugzilla with
PostgreSQL, however, some queries are case-sensitive. This is due to
the way PostgreSQL handles case and accent sensitivity.
</para>
</section>
<section id="list">
<title>Bug Lists</title>
<para>If you run a search, a list of matching bugs will be returned.
</para>
<para>The format of the list is configurable. For example, it can be
sorted by clicking the column headings. Other useful features can be
accessed using the links at the bottom of the list:
<simplelist>
<member>
<emphasis>Long Format:</emphasis>
this gives you a large page with a non-editable summary of the fields
of each bug.</member>
<member>
<emphasis>XML:</emphasis>
get the buglist in the XML format.</member>
<member>
<emphasis>CSV:</emphasis>
get the buglist as comma-separated values, for import into e.g.
a spreadsheet.</member>
<member>
<emphasis>Feed:</emphasis>
get the buglist as an Atom feed. Copy this link into your
favorite feed reader. If you are using Firefox, you can also
save the list as a live bookmark by clicking the live bookmark
icon in the status bar. To limit the number of bugs in the feed,
add a limit=n parameter to the URL.</member>
<member>
<emphasis>iCalendar:</emphasis>
Get the buglist as an iCalendar file. Each bug is represented as a
to-do item in the imported calendar.</member>
<member>
<emphasis>Change Columns:</emphasis>
change the bug attributes which appear in the list.</member>
<member>
<emphasis>Change several bugs at once:</emphasis>
If your account is sufficiently empowered, and more than one bug
appear in the bug list, this link is displayed which lets you make
the same change to all the bugs in the list - for example, changing
their assignee.</member>
<member>
<emphasis>Send mail to bug assignees:</emphasis>
If more than one bug appear in the bug list and there are at least
two distinct bug assignees, this links is displayed which lets you
easily send a mail to the assignees of all bugs on the list.</member>
<member>
<emphasis>Edit Search:</emphasis>
If you didn't get exactly the results you were looking for, you can
return to the Query page through this link and make small revisions
to the query you just made so you get more accurate results.</member>
<member>
<emphasis>Remember Search As:</emphasis>
You can give a search a name and remember it; a link will appear
in your page footer giving you quick access to run it again later.
</member>
</simplelist>
</para>
<para>
If you would like to access the bug list from another program
it is often useful to have the list returned in something other
than HTML. By adding the ctype=type parameter into the bug list URL
you can specify several alternate formats. Besides the types described
above, the following formats are also supported: ECMAScript, also known
as JavaScript (ctype=js), and Resource Description Framework RDF/XML
(ctype=rdf).
</para>
</section>
<section id="individual-buglists">
<title>Adding/removing tags to/from bugs</title>
<para>
You can add and remove tags from individual bugs, which let you find and
manage them more easily. Creating a new tag automatically generates a saved
search - whose name is the name of the tag - which lists bugs with this tag.
This saved search will be displayed in the footer of pages by default, as
all other saved searches. The main difference between tags and normal saved
searches is that saved searches, as described in the previous section, are
stored in the form of a list of matching criteria, while the saved search
generated by tags is a list of bug numbers. Consequently, you can easily
edit this list by either adding or removing tags from bugs. To enable this
feature, you have to turn on the <quote>Enable tags for bugs</quote> user
preference, see <xref linkend="userpreferences" />. This feature is disabled
by default.
</para>
<para>
This feature is useful when you want to keep track of several bugs, but
for different reasons. Instead of adding yourself to the CC list of all
these bugs and mixing all these reasons, you can now store these bugs in
separate lists, e.g. <quote>Keep in mind</quote>, <quote>Interesting bugs</quote>,
or <quote>Triage</quote>. One big advantage of this way to manage bugs
is that you can easily add or remove bugs one by one, which is not
possible to do with saved searches without having to edit the search
criteria again.
</para>
</section>
</section>
<section id="bugreports">
<title>Filing Bugs</title>
<section id="fillingbugs">
<title>Reporting a New Bug</title>
<para>Years of bug writing experience has been distilled for your
reading pleasure into the
<ulink
url="&landfillbase;page.cgi?id=bug-writing.html">
Bug Writing Guidelines</ulink>.
While some of the advice is Mozilla-specific, the basic principles of
reporting Reproducible, Specific bugs, isolating the Product you are
using, the Version of the Product, the Component which failed, the
Hardware Platform, and Operating System you were using at the time of
the failure go a long way toward ensuring accurate, responsible fixes
for the bug that bit you.</para>
<para>The procedure for filing a bug is as follows:</para>
<orderedlist>
<listitem>
<para>
Click the <quote>New</quote> link available in the footer
of pages, or the <quote>Enter a new bug report</quote> link
displayed on the home page of the Bugzilla installation.
</para>
<note>
<para>
If you want to file a test bug to see how Bugzilla works,
you can do it on one of our test installations on
<ulink url="&landfillbase;">Landfill</ulink>.
</para>
</note>
</listitem>
<listitem>
<para>
You first have to select the product in which you found a bug.
</para>
</listitem>
<listitem>
<para>
You now see a form where you can specify the component (part of
the product which is affected by the bug you discovered; if you have
no idea, just select <quote>General</quote> if such a component exists),
the version of the program you were using, the Operating System and
platform your program is running on and the severity of the bug (if the
bug you found crashes the program, it's probably a major or a critical
bug; if it's a typo somewhere, that's something pretty minor; if it's
something you would like to see implemented, then that's an enhancement).
</para>
</listitem>
<listitem>
<para>
You now have to give a short but descriptive summary of the bug you found.
<quote>My program is crashing all the time</quote> is a very poor summary
and doesn't help developers at all. Try something more meaningful or
your bug will probably be ignored due to a lack of precision.
The next step is to give a very detailed list of steps to reproduce
the problem you encountered. Try to limit these steps to a minimum set
required to reproduce the problem. This will make the life of
developers easier, and the probability that they consider your bug in
a reasonable timeframe will be much higher.
</para>
<note>
<para>
Try to make sure that everything in the summary is also in the first
comment. Summaries are often updated and this will ensure your original
information is easily accessible.
</para>
</note>
</listitem>
<listitem>
<para>
As you file the bug, you can also attach a document (testcase, patch,
or screenshot of the problem).
</para>
</listitem>
<listitem>
<para>
Depending on the Bugzilla installation you are using and the product in
which you are filing the bug, you can also request developers to consider
your bug in different ways (such as requesting review for the patch you
just attached, requesting your bug to block the next release of the
product, and many other product specific requests).
</para>
</listitem>
<listitem>
<para>
Now is a good time to read your bug report again. Remove all misspellings,
otherwise your bug may not be found by developers running queries for some
specific words, and so your bug would not get any attention.
Also make sure you didn't forget any important information developers
should know in order to reproduce the problem, and make sure your
description of the problem is explicit and clear enough.
When you think your bug report is ready to go, the last step is to
click the <quote>Commit</quote> button to add your report into the database.
</para>
</listitem>
</orderedlist>
<para>
You do not need to put "any" or similar strings in the URL field.
If there is no specific URL associated with the bug, leave this
field blank.
</para>
<para>If you feel a bug you filed was incorrectly marked as a
DUPLICATE of another, please question it in your bug, not
the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed.
</para>
</section>
<section id="cloningbugs">
<title>Clone an Existing Bug</title>
<para>
Starting with version 2.20, Bugzilla has a feature that allows you
to clone an existing bug. The newly created bug will inherit
most settings from the old bug. This allows you to track more
easily similar concerns in a new bug. To use this, go to the bug
that you want to clone, then click the <quote>Clone This Bug</quote>
link on the bug page. This will take you to the <quote>Enter Bug</quote>
page that is filled with the values that the old bug has.
You can change those values and/or texts if needed.
</para>
</section>
</section>
<section id="attachments">
<title>Attachments</title>
<para>
You should use attachments, rather than comments, for large chunks of ASCII
data, such as trace, debugging output files, or log files. That way, it
doesn't bloat the bug for everyone who wants to read it, and cause people to
receive fat, useless mails.
</para>
<para>You should make sure to trim screenshots. There's no need to show the
whole screen if you are pointing out a single-pixel problem.
</para>
<para>Bugzilla stores and uses a Content-Type for each attachment
(e.g. text/html). To download an attachment as a different
Content-Type (e.g. application/xhtml+xml), you can override this
using a 'content_type' parameter on the URL, e.g.
<filename>&amp;content_type=text/plain</filename>.
</para>
<para>
If you have a really large attachment, something that does not need to
be recorded forever (as most attachments are), or something that is too
big for your database, you can mark your attachment as a
<quote>Big File</quote>, assuming the administrator of the installation
has enabled this feature. Big Files are stored directly on disk instead
of in the database. The maximum size of a <quote>Big File</quote> is
normally larger than the maximum size of a regular attachment. Independently
of the storage system used, an administrator can delete these attachments
at any time. Nevertheless, if these files are stored in the database, the
<quote>allow_attachment_deletion</quote> parameter (which is turned off
by default) must be enabled in order to delete them.
</para>
<para>
Also, if the administrator turned on the <quote>allow_attach_url</quote>
parameter, you can enter the URL pointing to the attachment instead of
uploading the attachment itself. For example, this is useful if you want to
point to an external application, a website or a very large file. Note that
there is no guarantee that the source file will always be available, nor
that its content will remain unchanged.
</para>
<section id="patchviewer">
<title>Patch Viewer</title>
<para>Viewing and reviewing patches in Bugzilla is often difficult due to
lack of context, improper format and the inherent readability issues that
raw patches present. Patch Viewer is an enhancement to Bugzilla designed
to fix that by offering increased context, linking to sections, and
integrating with Bonsai, LXR and CVS.</para>
<para>Patch viewer allows you to:</para>
<simplelist>
<member>View patches in color, with side-by-side view rather than trying
to interpret the contents of the patch.</member>
<member>See the difference between two patches.</member>
<member>Get more context in a patch.</member>
<member>Collapse and expand sections of a patch for easy
reading.</member>
<member>Link to a particular section of a patch for discussion or
review</member>
<member>Go to Bonsai or LXR to see more context, blame, and
cross-references for the part of the patch you are looking at</member>
<member>Create a rawtext unified format diff out of any patch, no
matter what format it came from</member>
</simplelist>
<section id="patchviewer_view">
<title>Viewing Patches in Patch Viewer</title>
<para>The main way to view a patch in patch viewer is to click on the
"Diff" link next to a patch in the Attachments list on a bug. You may
also do this within the edit window by clicking the "View Attachment As
Diff" button in the Edit Attachment screen.</para>
</section>
<section id="patchviewer_diff">
<title>Seeing the Difference Between Two Patches</title>
<para>To see the difference between two patches, you must first view the
newer patch in Patch Viewer. Then select the older patch from the
dropdown at the top of the page ("Differences between [dropdown] and
this patch") and click the "Diff" button. This will show you what
is new or changed in the newer patch.</para>
</section>
<section id="patchviewer_context">
<title>Getting More Context in a Patch</title>
<para>To get more context in a patch, you put a number in the textbox at
the top of Patch Viewer ("Patch / File / [textbox]") and hit enter.
This will give you that many lines of context before and after each
change. Alternatively, you can click on the "File" link there and it
will show each change in the full context of the file. This feature only
works against files that were diffed using "cvs diff".</para>
</section>
<section id="patchviewer_collapse">
<title>Collapsing and Expanding Sections of a Patch</title>
<para>To view only a certain set of files in a patch (for example, if a
patch is absolutely huge and you want to only review part of it at a
time), you can click the "(+)" and "(-)" links next to each file (to
expand it or collapse it). If you want to collapse all files or expand
all files, you can click the "Collapse All" and "Expand All" links at the
top of the page.</para>
</section>
<section id="patchviewer_link">
<title>Linking to a Section of a Patch</title>
<para>To link to a section of a patch (for example, if you want to be
able to give someone a URL to show them which part you are talking
about) you simply click the "Link Here" link on the section header. The
resulting URL can be copied and used in discussion.</para>
</section>
<section id="patchviewer_bonsai_lxr">
<title>Going to Bonsai and LXR</title>
<para>To go to Bonsai to get blame for the lines you are interested in,
you can click the "Lines XX-YY" link on the section header you are
interested in. This works even if the patch is against an old
version of the file, since Bonsai stores all versions of the file.</para>
<para>To go to LXR, you click on the filename on the file header
(unfortunately, since LXR only does the most recent version, line
numbers are likely to rot).</para>
</section>
<section id="patchviewer_unified_diff">
<title>Creating a Unified Diff</title>
<para>If the patch is not in a format that you like, you can turn it
into a unified diff format by clicking the "Raw Unified" link at the top
of the page.</para>
</section>
</section>
</section>
<section id="hintsandtips">
<title>Hints and Tips</title>
<para>This section distills some Bugzilla tips and best practices
that have been developed.</para>
<section>
<title>Autolinkification</title>
<para>Bugzilla comments are plain text - so typing &lt;U&gt; will
produce less-than, U, greater-than rather than underlined text.
However, Bugzilla will automatically make hyperlinks out of certain
sorts of text in comments. For example, the text
"http://www.bugzilla.org" will be turned into a link:
<ulink url="http://www.bugzilla.org"/>.
Other strings which get linkified in the obvious manner are:
<simplelist>
<member>bug 12345</member>
<member>comment 7</member>
<member>bug 23456, comment 53</member>
<member>attachment 4321</member>
<member>mailto:george@example.com</member>
<member>george@example.com</member>
<member>ftp://ftp.mozilla.org</member>
<member>Most other sorts of URL</member>
</simplelist>
</para>
<para>A corollary here is that if you type a bug number in a comment,
you should put the word "bug" before it, so it gets autolinkified
for the convenience of others.
</para>
</section>
<section id="commenting">
<title>Comments</title>
<para>If you are changing the fields on a bug, only comment if
either you have something pertinent to say, or Bugzilla requires it.
Otherwise, you may spam people unnecessarily with bug mail.
To take an example: a user can set up their account to filter out messages
where someone just adds themselves to the CC field of a bug
(which happens a lot.) If you come along, add yourself to the CC field,
and add a comment saying "Adding self to CC", then that person
gets a pointless piece of mail they would otherwise have avoided.
</para>
<para>
Don't use sigs in comments. Signing your name ("Bill") is acceptable,
if you do it out of habit, but full mail/news-style
four line ASCII art creations are not.
</para>
</section>
<section id="comment-wrapping">
<title>Server-Side Comment Wrapping</title>
<para>
Bugzilla stores comments unwrapped and wraps them at display time. This
ensures proper wrapping in all browsers. Lines beginning with the ">"
character are assumed to be quotes, and are not wrapped.
</para>
</section>
<section id="dependencytree">
<title>Dependency Tree</title>
<para>
On the <quote>Dependency tree</quote> page linked from each bug
page, you can see the dependency relationship from the bug as a
tree structure.
</para>
<para>
You can change how much depth to show, and you can hide resolved bugs
from this page. You can also collaps/expand dependencies for
each bug on the tree view, using the [-]/[+] buttons that appear
before its summary. This option is not available for terminal
bugs in the tree (that don't have further dependencies).
</para>
</section>
</section>
<section id="timetracking">
<title>Time Tracking Information</title>
<para>
Users who belong to the group specified by the <quote>timetrackinggroup</quote>
parameter have access to time-related fields. Developers can see
deadlines and estimated times to fix bugs, and can provide time spent
on these bugs.
</para>
<para>
At any time, a summary of the time spent by developers on bugs is
accessible either from bug lists when clicking the <quote>Time Summary</quote>
button or from individual bugs when clicking the <quote>Summarize time</quote>
link in the time tracking table. The <filename>summarize_time.cgi</filename>
page lets you view this information either per developer or per bug,
and can be split on a month basis to have greater details on how time
is spent by developers.
</para>
<para>
As soon as a bug is marked as RESOLVED, the remaining time expected
to fix the bug is set to zero. This lets QA people set it again for
their own usage, and it will be set to zero again when the bug will
be marked as CLOSED.
</para>
</section>
<section id="userpreferences">
<title>User Preferences</title>
<para>
Once logged in, you can customize various aspects of
Bugzilla via the "Preferences" link in the page footer.
The preferences are split into five tabs:</para>
<section id="generalpreferences" xreflabel="General Preferences">
<title>General Preferences</title>
<para>
This tab allows you to change several default settings of Bugzilla.
</para>
<itemizedlist spacing="compact">
<listitem>
<para>
Bugzilla's general appearance (skin) - select which skin to use.
Bugzilla supports adding custom skins.
</para>
</listitem>
<listitem>
<para>
Quote the associated comment when you click on its reply link - sets
the behavior of the comment "Reply" link. Options include quoting the
full comment, just reference the comment number, or turn the link off.
</para>
</listitem>
<listitem>
<para>
Language used in email - select which language email will be sent in,
from the list of available languages.
</para>
</listitem>
<listitem>
<para>
After changing a bug - This controls what page is displayed after
changes to a bug are submitted. The options include to show the bug
just modified, to show the next bug in your list, or to do nothing.
</para>
</listitem>
<listitem>
<para>
Enable tags for bugs - turn bug tagging on or off.
</para>
</listitem>
<listitem>
<para>
Zoom textareas large when in use (requires JavaScript) - enable or
disable the automatic expanding of text areas when text is being
entered into them.
</para>
</listitem>
<listitem>
<para>
Field separator character for CSV files -
Select between a comma and semi-colon for exported CSV bug lists.
</para>
</listitem>
<listitem>
<para>
Automatically add me to the CC list of bugs I change - set default
behavior of CC list. Options include "Always", "Never", and "Only
if I have no role on them".
</para>
</listitem>
<listitem>
<para>
When viewing a bug, show comments in this order -
controls the order of comments. Options include "Oldest
to Newest", "Newest to Oldest" and "Newest to Oldest, but keep the
bug description at the top".
</para>
</listitem>
<listitem>
<para>
Show a quip at the top of each bug list - controls
whether a quip will be shown on the Bug list page.
</para>
</listitem>
</itemizedlist>
</section>
<section id="emailpreferences">
<title>Email Preferences</title>
<para>
This tab allows you to enable or disable email notification on
specific events.
</para>
<para>
In general, users have almost complete control over how much (or
how little) email Bugzilla sends them. If you want to receive the
maximum amount of email possible, click the <quote>Enable All
Mail</quote> button. If you don't want to receive any email from
Bugzilla at all, click the <quote>Disable All Mail</quote> button.
</para>
<note>
<para>
A Bugzilla administrator can stop a user from receiving
bugmail by clicking the <quote>Bugmail Disabled</quote> checkbox
when editing the user account. This is a drastic step
best taken only for disabled accounts, as it overrides
the user's individual mail preferences.
</para>
</note>
<para>
There are two global options -- <quote>Email me when someone
asks me to set a flag</quote> and <quote>Email me when someone
sets a flag I asked for</quote>. These define how you want to
receive bugmail with regards to flags. Their use is quite
straightforward; enable the checkboxes if you want Bugzilla to
send you mail under either of the above conditions.
</para>
<para>
If you'd like to set your bugmail to something besides
'Completely ON' and 'Completely OFF', the
<quote>Field/recipient specific options</quote> table
allows you to do just that. The rows of the table
define events that can happen to a bug -- things like
attachments being added, new comments being made, the
priority changing, etc. The columns in the table define
your relationship with the bug:
</para>
<itemizedlist spacing="compact">
<listitem>
<para>
Reporter - Where you are the person who initially
reported the bug. Your name/account appears in the
<quote>Reporter:</quote> field.
</para>
</listitem>
<listitem>
<para>
Assignee - Where you are the person who has been
designated as the one responsible for the bug. Your
name/account appears in the <quote>Assigned To:</quote>
field of the bug.
</para>
</listitem>
<listitem>
<para>
QA Contact - You are one of the designated
QA Contacts for the bug. Your account appears in the
<quote>QA Contact:</quote> text-box of the bug.
</para>
</listitem>
<listitem>
<para>
CC - You are on the list CC List for the bug.
Your account appears in the <quote>CC:</quote> text box
of the bug.
</para>
</listitem>
<listitem>
<para>
Voter - You have placed one or more votes for the bug.
Your account appears only if someone clicks on the
<quote>Show votes for this bug</quote> link on the bug.
</para>
</listitem>
</itemizedlist>
<note>
<para>
Some columns may not be visible for your installation, depending
on your site's configuration.
</para>
</note>
<para>
To fine-tune your bugmail, decide the events for which you want
to receive bugmail; then decide if you want to receive it all
the time (enable the checkbox for every column), or only when
you have a certain relationship with a bug (enable the checkbox
only for those columns). For example: if you didn't want to
receive mail when someone added themselves to the CC list, you
could uncheck all the boxes in the <quote>CC Field Changes</quote>
line. As another example, if you never wanted to receive email
on bugs you reported unless the bug was resolved, you would
un-check all boxes in the <quote>Reporter</quote> column
except for the one on the <quote>The bug is resolved or
verified</quote> row.
</para>
<note>
<para>
Bugzilla adds the <quote>X-Bugzilla-Reason</quote> header to
all bugmail it sends, describing the recipient's relationship
(AssignedTo, Reporter, QAContact, CC, or Voter) to the bug.
This header can be used to do further client-side filtering.
</para>
</note>
<para>
Bugzilla has a feature called <quote>Users Watching</quote>.
When you enter one or more comma-delineated user accounts (usually email
addresses) into the text entry box, you will receive a copy of all the
bugmail those users are sent (security settings permitting).
This powerful functionality enables seamless transitions as developers
change projects or users go on holiday.
</para>
<note>
<para>
The ability to watch other users may not be available in all
Bugzilla installations. If you don't see this feature, and feel
that you need it, speak to your administrator.
</para>
</note>
<para>
Each user listed in the <quote>Users watching you</quote> field
has you listed in their <quote>Users to watch</quote> list
and can get bugmail according to your relationship to the bug and
their <quote>Field/recipient specific options</quote> setting.
</para>
</section>
<section id="savedsearches" xreflabel="Saved Searches">
<title>Saved Searches</title>
<para>
On this tab you can view and run any Saved Searches that you have
created, and also any Saved Searches that other members of the group
defined in the "querysharegroup" parameter have shared.
Saved Searches can be added to the page footer from this screen.
If somebody is sharing a Search with a group she or he is allowed to
<link linkend="groups">assign users to</link>, the sharer may opt to have
the Search show up in the footer of the group's direct members by default.
</para>
</section>
<section id="accountpreferences" xreflabel="Name and Password">
<title>Name and Password</title>
<para>On this tab, you can change your basic account information,
including your password, email address and real name. For security
reasons, in order to change anything on this page you must type your
<emphasis>current</emphasis> password into the <quote>Password</quote>
field at the top of the page.
If you attempt to change your email address, a confirmation
email is sent to both the old and new addresses, with a link to use to
confirm the change. This helps to prevent account hijacking.</para>
</section>
<section id="permissionsettings">
<title>Permissions</title>
<para>
This is a purely informative page which outlines your current
permissions on this installation of Bugzilla.
</para>
<para>
A complete list of permissions is below. Only users with
<emphasis>editusers</emphasis> privileges can change the permissions
of other users.
</para>
<variablelist>
<varlistentry>
<term>
admin
</term>
<listitem>
<para>
Indicates user is an Administrator.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
bz_canusewhineatothers
</term>
<listitem>
<para>
Indicates user can configure whine reports for other users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
bz_canusewhines
</term>
<listitem>
<para>
Indicates user can configure whine reports for self.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
bz_sudoers
</term>
<listitem>
<para>
Indicates user can perform actions as other users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
bz_sudo_protect
</term>
<listitem>
<para>
Indicates user can not be impersonated by other users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
canconfirm
</term>
<listitem>
<para>
Indicates user can confirm a bug or mark it a duplicate.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
creategroups
</term>
<listitem>
<para>
Indicates user can create and destroy groups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
editbugs
</term>
<listitem>
<para>
Indicates user can edit all bug fields.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
editclassifications
</term>
<listitem>
<para>
Indicates user can create, destroy, and edit classifications.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
editcomponents
</term>
<listitem>
<para>
Indicates user can create, destroy, and edit components.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
editkeywords
</term>
<listitem>
<para>
Indicates user can create, destroy, and edit keywords.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
editusers
</term>
<listitem>
<para>
Indicates user can edit or disable users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
tweakparams
</term>
<listitem>
<para>
Indicates user can change Parameters.
</para>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>
For more information on how permissions work in Bugzilla (i.e. who can
change what), see <xref linkend="cust-change-permissions"/>.
</para>
</note>
</section>
</section>
<section id="reporting">
<title>Reports and Charts</title>
<para>As well as the standard buglist, Bugzilla has two more ways of
viewing sets of bugs. These are the reports (which give different
views of the current state of the database) and charts (which plot
the changes in particular sets of bugs over time.)</para>
<section id="reports">
<title>Reports</title>
<para>
A report is a view of the current state of the bug database.
</para>
<para>
You can run either an HTML-table-based report, or a graphical
line/pie/bar-chart-based one. The two have different pages to
define them, but are close cousins - once you've defined and
viewed a report, you can switch between any of the different
views of the data at will.
</para>
<para>
Both report types are based on the idea of defining a set of bugs
using the standard search interface, and then choosing some
aspect of that set to plot on the horizontal and/or vertical axes.
You can also get a form of 3-dimensional report by choosing to have
multiple images or tables.
</para>
<para>
So, for example, you could use the search form to choose "all
bugs in the WorldControl product", and then plot their severity
against their component to see which component had had the largest
number of bad bugs reported against it.
</para>
<para>
Once you've defined your parameters and hit "Generate Report",
you can switch between HTML, CSV, Bar, Line and Pie. (Note: Pie
is only available if you didn't define a vertical axis, as pie
charts don't have one.) The other controls are fairly self-explanatory;
you can change the size of the image if you find text is overwriting
other text, or the bars are too thin to see.
</para>
</section>
<section id="charts">
<title>Charts</title>
<para>
A chart is a view of the state of the bug database over time.
</para>
<para>
Bugzilla currently has two charting systems - Old Charts and New
Charts. Old Charts have been part of Bugzilla for a long time; they
chart each status and resolution for each product, and that's all.
They are deprecated, and going away soon - we won't say any more
about them.
New Charts are the future - they allow you to chart anything you
can define as a search.
</para>
<note>
<para>
Both charting forms require the administrator to set up the
data-gathering script. If you can't see any charts, ask them whether
they have done so.
</para>
</note>
<para>
An individual line on a chart is called a data set.
All data sets are organised into categories and subcategories. The
data sets that Bugzilla defines automatically use the Product name
as a Category and Component names as Subcategories, but there is no
need for you to follow that naming scheme with your own charts if
you don't want to.
</para>
<para>
Data sets may be public or private. Everyone sees public data sets in
the list, but only their creator sees private data sets. Only
administrators can make data sets public.
No two data sets, even two private ones, can have the same set of
category, subcategory and name. So if you are creating private data
sets, one idea is to have the Category be your username.
</para>
<section>
<title>Creating Charts</title>
<para>
You create a chart by selecting a number of data sets from the
list, and pressing Add To List for each. In the List Of Data Sets
To Plot, you can define the label that data set will have in the
chart's legend, and also ask Bugzilla to Sum a number of data sets
(e.g. you could Sum data sets representing RESOLVED, VERIFIED and
CLOSED in a particular product to get a data set representing all
the resolved bugs in that product.)
</para>
<para>
If you've erroneously added a data set to the list, select it
using the checkbox and click Remove. Once you add more than one
data set, a "Grand Total" line
automatically appears at the bottom of the list. If you don't want
this, simply remove it as you would remove any other line.
</para>
<para>
You may also choose to plot only over a certain date range, and
to cumulate the results - that is, to plot each one using the
previous one as a baseline, so the top line gives a sum of all
the data sets. It's easier to try than to explain :-)
</para>
<para>
Once a data set is in the list, one can also perform certain
actions on it. For example, one can edit the
data set's parameters (name, frequency etc.) if it's one you
created or if you are an administrator.
</para>
<para>
Once you are happy, click Chart This List to see the chart.
</para>
</section>
<section id="charts-new-series">
<title>Creating New Data Sets</title>
<para>
You may also create new data sets of your own. To do this,
click the "create a new data set" link on the Create Chart page.
This takes you to a search-like interface where you can define
the search that Bugzilla will plot. At the bottom of the page,
you choose the category, sub-category and name of your new
data set.
</para>
<para>
If you have sufficient permissions, you can make the data set public,
and reduce the frequency of data collection to less than the default
seven days.
</para>
</section>
</section>
</section>
<section id="flags">
<title>Flags</title>
<para>
A flag is a kind of status that can be set on bugs or attachments
to indicate that the bugs/attachments are in a certain state.
Each installation can define its own set of flags that can be set
on bugs or attachments.
</para>
<para>
If your installation has defined a flag, you can set or unset that flag,
and if your administrator has enabled requesting of flags, you can submit
a request for another user to set the flag.
</para>
<para>
To set a flag, select either "+" or "-" from the drop-down menu next to
the name of the flag in the "Flags" list. The meaning of these values are
flag-specific and thus cannot be described in this documentation,
but by way of example, setting a flag named "review" to "+" may indicate
that the bug/attachment has passed review, while setting it to "-"
may indicate that the bug/attachment has failed review.
</para>
<para>
To unset a flag, click its drop-down menu and select the blank value.
Note that marking an attachment as obsolete automatically cancels all
pending requests for the attachment.
</para>
<para>
If your administrator has enabled requests for a flag, request a flag
by selecting "?" from the drop-down menu and then entering the username
of the user you want to set the flag in the text field next to the menu.
</para>
<para>
A set flag appears in bug reports and on "edit attachment" pages with the
abbreviated username of the user who set the flag prepended to the
flag name. For example, if Jack sets a "review" flag to "+", it appears
as Jack: review [ + ]
</para>
<para>
A requested flag appears with the user who requested the flag prepended
to the flag name and the user who has been requested to set the flag
appended to the flag name within parentheses. For example, if Jack
asks Jill for review, it appears as Jack: review [ ? ] (Jill).
</para>
<para>
You can browse through open requests made of you and by you by selecting
'My Requests' from the footer. You can also look at open requests limited
by other requesters, requestees, products, components, and flag names from
this page. Note that you can use '-' for requestee to specify flags with
'no requestee' set.
</para>
</section>
<section id="whining">
<title>Whining</title>
<para>
Whining is a feature in Bugzilla that can regularly annoy users at
specified times. Using this feature, users can execute saved searches
at specific times (i.e. the 15th of the month at midnight) or at
regular intervals (i.e. every 15 minutes on Sundays). The results of the
searches are sent to the user, either as a single email or as one email
per bug, along with some descriptive text.
</para>
<warning>
<para>
Throughout this section it will be assumed that all users are members
of the bz_canusewhines group, membership in which is required in order
to use the Whining system. You can easily make all users members of
the bz_canusewhines group by setting the User RegExp to ".*" (without
the quotes).
</para>
<para>
Also worth noting is the bz_canusewhineatothers group. Members of this
group can create whines for any user or group in Bugzilla using a
extended form of the whining interface. Features only available to
members of the bz_canusewhineatothers group will be noted in the
appropriate places.
</para>
</warning>
<note>
<para>
For whining to work, a special Perl script must be executed at regular
intervals. More information on this is available in
<xref linkend="installation-whining"/>.
</para>
</note>
<note>
<para>
This section does not cover the whineatnews.pl script. See
<xref linkend="installation-whining-cron"/> for more information on
The Whining Cron.
</para>
</note>
<section id="whining-overview">
<title>The Event</title>
<para>
The whining system defines an "Event" as one or more queries being
executed at regular intervals, with the results of said queries (if
there are any) being emailed to the user. Events are created by
clicking on the "Add new event" button.
</para>
<para>
Once a new event is created, the first thing to set is the "Email
subject line". The contents of this field will be used in the subject
line of every email generated by this event. In addition to setting a
subject, space is provided to enter some descriptive text that will be
included at the top of each message (to help you in understanding why
you received the email in the first place).
</para>
<para>
The next step is to specify when the Event is to be run (the Schedule)
and what searches are to be performed (the Searches).
</para>
</section>
<section id="whining-schedule">
<title>Whining Schedule</title>
<para>
Each whining event is associated with zero or more schedules. A
schedule is used to specify when the query (specified below) is to be
run. A new event starts out with no schedules (which means it will
never run, as it is not scheduled to run). To add a schedule, press
the "Add a new schedule" button.
</para>
<para>
Each schedule includes an interval, which you use to tell Bugzilla
when the event should be run. An event can be run on certain days of
the week, certain days of the month, during weekdays (defined as
Monday through Friday), or every day.
</para>
<warning>
<para>
Be careful if you set your event to run on the 29th, 30th, or 31st of
the month, as your event may not run exactly when expected. If you
want your event to run on the last day of the month, select "Last day
of the month" as the interval.
</para>
</warning>
<para>
Once you have specified the day(s) on which the event is to be run, you
should now specify the time at which the event is to be run. You can
have the event run at a certain hour on the specified day(s), or
every hour, half-hour, or quarter-hour on the specified day(s).
</para>
<para>
If a single schedule does not execute an event as many times as you
would want, you can create another schedule for the same event. For
example, if you want to run an event on days whose numbers are
divisible by seven, you would need to add four schedules to the event,
setting the schedules to run on the 7th, 14th, 21st, and 28th (one day
per schedule) at whatever time (or times) you choose.
</para>
<note>
<para>
If you are a member of the bz_canusewhineatothers group, then you
will be presented with another option: "Mail to". Using this you
can control who will receive the emails generated by this event. You
can choose to send the emails to a single user (identified by email
address) or a single group (identified by group name). To send to
multiple users or groups, create a new schedule for each additional
user/group.
</para>
</note>
</section>
<section id="whining-query">
<title>Whining Searches</title>
<para>
Each whining event is associated with zero or more searches. A search
is any saved search to be run as part of the specified schedule (see
above). You start out without any searches associated with the event
(which means that the event will not run, as there will never be any
results to return). To add a search, press the "Include search" button.
</para>
<para>
The first field to examine in your newly added search is the Sort field.
Searches are run, and results included, in the order specified by the
Sort field. Searches with smaller Sort values will run before searches
with bigger Sort values.
</para>
<para>
The next field to examine is the Search field. This is where you
choose the actual search that is to be run. Instead of defining search
parameters here, you are asked to choose from the list of saved
searches (the same list that appears at the bottom of every Bugzilla
page). You are only allowed to choose from searches that you have
saved yourself (the default saved search, "My Bugs", is not a valid
choice). If you do not have any saved searches, you can take this
opportunity to create one (see <xref linkend="list"/>).
</para>
<note>
<para>
When running queries, the whining system acts as if you are the user
executing the query. This means that the whining system will ignore
bugs that match your query, but that you can not access.
</para>
</note>
<para>
Once you have chosen the saved search to be executed, give the query a
descriptive title. This title will appear in the email, above the
results of the query. If you choose "One message per bug", the query
title will appear at the top of each email that contains a bug matching
your query.
</para>
<para>
Finally, decide if the results of the query should be sent in a single
email, or if each bug should appear in its own email.
</para>
<warning>
<para>
Think carefully before checking the "One message per bug" box. If
you create a query that matches thousands of bugs, you will receive
thousands of emails!
</para>
</warning>
</section>
<section>
<title>Saving Your Changes</title>
<para>
Once you have defined at least one schedule, and created at least one
query, go ahead and "Update/Commit". This will save your Event and make
it available for immediate execution.
</para>
<note>
<para>
If you ever feel like deleting your event, you may do so using the
"Remove Event" button in the upper-right corner of each Event. You
can also modify an existing event, so long as you "Update/Commit"
after completing your modifications.
</para>
</note>
</section>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
<?xml version="1.0"?>
<!--
-
- The contents of this file are subject to the Mozilla Public
- License Version 1.1 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at http://www.mozilla.org/MPL/
-
- Software distributed under the License is distributed on an "AS
- IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
- implied. See the License for the specific language governing
- rights and limitations under the License.
-
- The Original Code is the Bugzilla Bug Tracking System.
-
- The Initial Developer of the Original Code is Netscape Communications
- Corporation. Portions created by Netscape are
- Copyright (C) 1998 Netscape Communications Corporation. All
- Rights Reserved.
-
- Contributor(s): Myk Melez <myk@mozilla.org>
-
-->
<!DOCTYPE window [
<!ENTITY idColumn.label "ID">
<!ENTITY duplicateCountColumn.label "Count">
<!ENTITY duplicateDeltaColumn.label "Delta">
<!ENTITY componentColumn.label "Component">
<!ENTITY severityColumn.label "Severity">
<!ENTITY osColumn.label "OS">
<!ENTITY targetMilestoneColumn.label "Milestone">
<!ENTITY summaryColumn.label "Summary">
]>
<?xml-stylesheet href="chrome://global/skin/" type="text/css"?>
<?xml-stylesheet href="skins/standard/duplicates.css" type="text/css"?>
<window id="duplicates_report"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
title="Duplicates Report">
// Code for populating the tree from the RDF data source
// and loading bug reports when the user selects rows in the tree.
<script type="application/x-javascript" src="js/duplicates.js" />
<tree id="results-tree" flex="1"
flags="dont-build-content"
enableColumnDrag="true"
datasources="rdf:null"
ref=""
onselect="loadBugInPane();"
ondblclick="loadBugInWindow();">
<treecols>
<treecol id="id_column" label="&idColumn.label;" primary="true" sort="?id"
persist="width hidden sortActive sortDirection ordinal" />
<splitter class="tree-splitter"/>
<treecol id="duplicate_count_column" label="&duplicateCountColumn.label;" sort="?duplicate_count"
sortActive="true" sortDirection="descending"
persist="width hidden sortActive sortDirection ordinal" />
<splitter class="tree-splitter" />
<treecol id="duplicate_delta_column" label="&duplicateDeltaColumn.label;" sort="?duplicate_delta"
persist="width hidden sortActive sortDirection ordinal" />
<splitter class="tree-splitter"/>
<treecol id="component_column" label="&componentColumn.label;" flex="3" sort="?component"
persist="width hidden sortActive sortDirection ordinal" />
<splitter class="tree-splitter"/>
<treecol id="severity_column" label="&severityColumn.label;" flex="1" sort="?severity"
persist="width hidden sortActive sortDirection ordinal" />
<splitter class="tree-splitter"/>
<treecol id="os_column" label="&osColumn.label;" flex="2" sort="?os"
persist="width hidden sortActive sortDirection ordinal" />
<splitter class="tree-splitter"/>
<treecol id="target_milestone_column" label="&targetMilestoneColumn.label;" flex="1" sort="?target_milestone"
persist="width hidden sortActive sortDirection ordinal" />
<splitter class="tree-splitter"/>
<treecol id="summary_column" label="&summaryColumn.label;" flex="12" sort="?summary"
persist="width hidden sortActive sortDirection ordinal" />
</treecols>
<template>
<rule>
<conditions>
<treeitem uri="?uri" />
<triple subject="?uri" predicate="http://www.bugzilla.org/rdf#bugs" object="?bugs" />
<member container="?bugs" child="?bug" />
<triple subject="?bug" predicate="http://www.bugzilla.org/rdf#id" object="?id" />
</conditions>
<bindings>
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#duplicate_count" object="?duplicate_count" />
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#duplicate_delta" object="?duplicate_delta" />
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#component" object="?component" />
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#severity" object="?severity" />
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#priority" object="?priority" />
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#os" object="?os" />
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#target_milestone" object="?target_milestone" />
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#summary" object="?summary" />
<binding subject="?bug" predicate="http://www.bugzilla.org/rdf#resolution" object="?resolution" />
</bindings>
<action>
<treechildren>
<treeitem uri="?bug">
<treerow properties="resolution-?resolution">
<treecell ref="id_column" label="?id" properties="resolution-?resolution" />
<treecell ref="duplicate_count_column" label="?duplicate_count" properties="resolution-?resolution" />
<treecell ref="duplicate_delta_column" label="?duplicate_delta" properties="resolution-?resolution" />
<treecell ref="component_column" label="?component" properties="resolution-?resolution" />
<treecell ref="severity_column" label="?severity" properties="resolution-?resolution" />
<treecell ref="os_column" label="?os" properties="resolution-?resolution" />
<treecell ref="target_milestone_column" label="?target_milestone" properties="resolution-?resolution" />
<treecell ref="summary_column" label="?summary" properties="resolution-?resolution" />
</treerow>
</treeitem>
</treechildren>
</action>
</rule>
</template>
</tree>
<splitter id="report-content-splitter" collapse="after" state="open" persist="state">
<grippy/>
</splitter>
<iframe id="content-browser" src="about:blank" flex="2" persist="height" />
</window>
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical are Copyright (C) 2008 Canonical Ltd.
# All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
package extensions::Example::lib::AuthLogin;
use strict;
use base qw(Bugzilla::Auth::Login);
use constant user_can_create_account => 0;
use Bugzilla::Constants;
# Always returns no data.
sub get_login_info {
return { failure => AUTH_NODATA };
}
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical are Copyright (C) 2008 Canonical Ltd.
# All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
package extensions::Example::lib::AuthVerify;
use strict;
use base qw(Bugzilla::Auth::Verify);
use Bugzilla::Constants;
# A verifier that always fails.
sub check_credentials {
return { failure => AUTH_NO_SUCH_USER };
}
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
# Bradley Baetz <bbaetz@acm.org>
package extensions::Example::lib::ConfigExample;
use strict;
use warnings;
use Bugzilla::Config::Common;
sub get_param_list {
my ($class) = @_;
my @param_list = (
{
name => 'example_string',
type => 't',
default => 'EXAMPLE',
},
);
return @param_list;
}
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by Everything Solved, Inc. are Copyright (C) 2007
# Everything Solved, Inc. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
package extensions::Example::lib::WSExample;
use strict;
use warnings;
use base qw(Bugzilla::WebService);
use Bugzilla::Error;
# This can be called as Example.hello() from the WebService.
sub hello { return 'Hello!'; }
sub throw_an_error { ThrowUserError('example_my_error') }
1;
[%# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Bradley Baetz <bbaetz@everythingsolved.com>
#%]
[% IF san_tag == "example_check_au_user" %]
<em>EXAMPLE PLUGIN</em> - Checking for non-Australian users.
[% ELSIF san_tag == "example_check_au_user_alert" %]
User &lt;[% login FILTER html %]&gt; isn't Australian.
[% IF user.in_group('editusers') %]
<a href="editusers.cgi?id=[% userid FILTER none %]">Edit this user</a>.
[% END %]
[% ELSIF san_tag == "example_check_au_user_prompt" %]
<a href="sanitycheck.cgi?example_repair_au_user=1">Fix these users</a>.
[% ELSIF san_tag == "example_repair_au_user_start" %]
<em>EXAMPLE PLUGIN</em> - OK, would now make users Australian.
[% ELSIF san_tag == "example_repair_au_user_end" %]
<em>EXAMPLE PLUGIN</em> - Users would now be Australian.
[% END %]
[%# Note that error messages should generally be indented four spaces, like
# below, because when Bugzilla translates an error message into plain
# text, it takes four spaces off the beginning of the lines.
#
# Note also that I prefixed my error name with "example", the name of my
# extension, so that I wouldn't conflict with other error names in
# Bugzilla or other extensions.
#%]
[% IF error == "example_my_error" %]
[% title = "Example Error Title" %]
This is the error message! It contains <em>some html</em>.
[% END %]
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Frédéric Buclin.
# Portions created by Frédéric Buclin are Copyright (C) 2009
# Frédéric Buclin. All Rights Reserved.
#
# Contributor(s): Frédéric Buclin <LpSolit@gmail.com>
use strict;
use Image::Magick;
use Bugzilla;
my $args = Bugzilla->hook_args;
return unless $args->{attributes}->{mimetype} eq 'image/bmp';
my $data = ${$args->{data}};
my $img = Image::Magick->new(magick=>'bmp');
# $data is a filehandle.
if (ref $data) {
$img->Read(file => \*$data);
$img->set(magick=>'png');
$img->Write(file => \*$data);
}
# $data is a blob.
else {
$img->BlobToImage($data);
$img->set(magick=>'png');
$data = $img->ImageToBlob();
}
${$args->{data}} = $data;
$args->{attributes}->{mimetype} = 'image/png';
$args->{attributes}->{filename} =~ s/^(.+)\.bmp$/$1.png/i;
undef $img;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Frédéric Buclin.
# Portions created by Frédéric Buclin are Copyright (C) 2009
# Frédéric Buclin. All Rights Reserved.
#
# Contributor(s): Frédéric Buclin <LpSolit@gmail.com>
use strict;
{ x_name => 'BMP to PNG converter',
version => '1.0',
x_description => 'Automatically converts BMP images to the PNG format',
x_author => 'Greg Hendricks, Frédéric Buclin',
};
File mode changed from 100644 to 100755
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Frédéric Buclin.
# Portions created by Frédéric Buclin are Copyright (C) 2009
# Frédéric Buclin. All Rights Reserved.
#
# Contributor(s): Frédéric Buclin <LpSolit@gmail.com>
use strict;
use warnings;
use Bugzilla;
my $args = Bugzilla->hook_args;
my $type = $args->{attributes}->{mimetype};
my $filename = $args->{attributes}->{filename};
# Make sure images have the correct extension.
# Uncomment the two lines below to make this check effective.
if ($type =~ /^image\/(\w+)$/) {
my $format = $1;
if ($filename =~ /^(.+)(:?\.[^\.]+)$/) {
my $name = $1;
# $args->{attributes}->{filename} = "${name}.$format";
}
else {
# The file has no extension. We append it.
# $args->{attributes}->{filename} .= ".$format";
}
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $modules = Bugzilla->hook_args->{modules};
if (exists $modules->{Example}) {
$modules->{Example} = 'extensions/example/lib/AuthLogin.pm';
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $modules = Bugzilla->hook_args->{modules};
if (exists $modules->{Example}) {
$modules->{Example} = 'extensions/example/lib/AuthVerify.pm';
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Elliotte Martin <elliotte_martin@yahoo.com>
use strict;
use warnings;
use Bugzilla;
my $columns = Bugzilla->hook_args->{'columns'};
push (@$columns, "delta_ts AS example")
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
# Bradley Baetz <bbaetz@acm.org>
use strict;
use warnings;
use Bugzilla;
# This code doesn't actually *do* anything, it's just here to show you
# how to use this hook.
my $args = Bugzilla->hook_args;
my $bug = $args->{'bug'};
my $timestamp = $args->{'timestamp'};
my $bug_id = $bug->id;
# Uncomment this line to see a line in your webserver's error log whenever
# you file a bug.
# warn "Bug $bug_id has been filed!";
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
use Data::Dumper;
# This code doesn't actually *do* anything, it's just here to show you
# how to use this hook.
my $params = Bugzilla->hook_args->{'params'};
# Uncomment this line below to see a line in your webserver's error log
# containing all validated bug field values every time you file a bug.
# warn Dumper($params);
# This would remove all ccs from the bug, preventing ANY ccs from being
# added on bug creation.
# $params->{cc} = [];
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by Everything Solved are Copyright (C) 2008
# Everything Solved, Inc. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
use Bugzilla::Status;
# This code doesn't actually *do* anything, it's just here to show you
# how to use this hook.
my $args = Bugzilla->hook_args;
my $bug = $args->{'bug'};
my $timestamp = $args->{'timestamp'};
my $changes = $args->{'changes'};
foreach my $field (keys %$changes) {
my $used_to_be = $changes->{$field}->[0];
my $now_it_is = $changes->{$field}->[1];
}
my $status_message;
if (my $status_change = $changes->{'bug_status'}) {
my $old_status = new Bugzilla::Status({ name => $status_change->[0] });
my $new_status = new Bugzilla::Status({ name => $status_change->[1] });
if ($new_status->is_open && !$old_status->is_open) {
$status_message = "Bug re-opened!";
}
if (!$new_status->is_open && $old_status->is_open) {
$status_message = "Bug closed!";
}
}
my $bug_id = $bug->id;
my $num_changes = scalar keys %$changes;
my $result = "There were $num_changes changes to fields on bug $bug_id"
. " at $timestamp.";
# Uncomment this line to see $result in your webserver's error log whenever
# you update a bug.
# warn $result;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Elliotte Martin <elliotte_martin@yahoo.com>
use strict;
use warnings;
use Bugzilla;
my $fields = Bugzilla->hook_args->{'fields'};
push (@$fields, "example")
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2009
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
use Bugzilla::ExampleHook qw(replace_bar);
# This replaces every occurrence of the word "foo" with the word
# "bar"
my $regexes = Bugzilla->hook_args->{'regexes'};
push(@$regexes, { match => qr/\bfoo\b/, replace => 'bar' });
# And this links every occurrence of the word "bar" to example.com,
# but it won't affect "foo"s that have already been turned into "bar"
# above (because each regex is run in order, and later regexes don't modify
# earlier matches, due to some cleverness in Bugzilla's internals).
#
# For example, the phrase "foo bar" would become:
# bar <a href="http://example.com/bar">bar</a>
#
# See lib/Bugzilla/ExampleHook.pm in this extension for the code of
# "replace_bar".
my $bar_match = qr/\b(bar)\b/;
push(@$regexes, { match => $bar_match, replace => \&replace_bar });
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
## The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Elliotte Martin <elliotte_martin@yahoo.com>
use strict;
use warnings;
use Bugzilla;
my $columns = Bugzilla->hook_args->{'columns'};
$columns->{'example'} = { 'name' => 'bugs.delta_ts' , 'title' => 'Example' };
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Elliotte Martin <elliotte_martin@yahoo.com>
use strict;
use warnings;
use Bugzilla;
my $columns = Bugzilla->hook_args->{'columns'};
push (@$columns, "example")
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Bradley Baetz <bbaetz@acm.org>
use strict;
use warnings;
use Bugzilla;
my $modules = Bugzilla->hook_args->{panel_modules};
$modules->{Example} = "extensions::example::lib::ConfigExample";
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $panels = Bugzilla->hook_args->{panels};
# Add the "Example" auth methods.
my $auth_params = $panels->{'auth'}->{params};
my ($info_class) = grep($_->{name} eq 'user_info_class', @$auth_params);
my ($verify_class) = grep($_->{name} eq 'user_verify_class', @$auth_params);
push(@{ $info_class->{choices} }, 'CGI,Example');
push(@{ $verify_class->{choices} }, 'Example');
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
# Bradley Baetz <bbaetz@acm.org>
use strict;
use warnings;
use Bugzilla;
my $config = Bugzilla->hook_args->{config};
$config->{Example} = "extensions::example::lib::ConfigExample";
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by Everything Solved are Copyright (C) 2008
# Everything Solved, Inc. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
use Bugzilla::Util qw(diff_arrays);
# This code doesn't actually *do* anything, it's just here to show you
# how to use this hook.
my $args = Bugzilla->hook_args;
my ($object, $timestamp, $old_flags, $new_flags) =
@$args{qw(object timestamp old_flags new_flags)};
my ($removed, $added) = diff_arrays($old_flags, $new_flags);
my ($granted, $denied) = (0, 0);
foreach my $new_flag (@$added) {
$granted++ if $new_flag =~ /\+$/;
$denied++ if $new_flag =~ /-$/;
}
my $bug_id = (ref $object eq 'Bugzilla::Bug') ? $object->id : $object->bug_id;
my $result = "$granted flags were granted and $denied flags were denied"
. " on bug $bug_id at $timestamp.";
# Uncomment this line to see $result in your webserver's error log whenever
# you update flags.
# warn $result;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Elliotte Martin <elliotte_martin@yahoo.com>
use strict;
use warnings;
use Bugzilla;
my $silent = Bugzilla->hook_args->{'silent'};
print "Install-before_final_checks hook\n" unless $silent;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by the Initial Developer are Copyright (C) 2008
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $email = Bugzilla->hook_args->{email};
# If you add a header to an email, it's best to start it with
# 'X-Bugzilla-<Extension>' so that you don't conflict with
# other extensions.
$email->header_set('X-Bugzilla-Example-Header', 'Example');
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $args = Bugzilla->hook_args;
my $class = $args->{'class'};
my $params = $args->{'params'};
# Note that this is a made-up class, for this example.
if ($class->isa('Bugzilla::ExampleObject')) {
warn "About to create an ExampleObject!";
warn "Got the following parameters: " . join(', ', keys(%$params));
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
my $args = Bugzilla->hook_args;
my ($object, $field, $value) = @$args{qw(object field value)};
# Note that this is a made-up class, for this example.
if ($object->isa('Bugzilla::ExampleObject')) {
warn "The field $field is changing from " . $object->{$field}
. " to $value!";
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $args = Bugzilla->hook_args;
my $class = $args->{'class'};
my $params = $args->{'params'};
# Note that this is a made-up class, for this example.
if ($class->isa('Bugzilla::ExampleObject')) {
# Always set example_field to 1, even if the validators said otherwise.
$params->{example_field} = 1;
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
my $args = Bugzilla->hook_args;
my $object = $args->{'class'};
my $params = $args->{'params'};
# Note that this is a made-up class, for this example.
if ($object->isa('Bugzilla::ExampleObject')) {
if ($params->{example_field} == 1) {
$object->{example_field} = 1;
}
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
my $args = Bugzilla->hook_args;
my ($object, $old_object, $changes) = @$args{qw(object old_object changes)};
# Note that this is a made-up class, for this example.
if ($object->isa('Bugzilla::ExampleObject')) {
if (defined $changes->{'name'}) {
my ($old, $new) = @{ $changes->{'name'} };
print "The name field changed from $old to $new!";
}
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2009
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my %args = %{ Bugzilla->hook_args };
my ($vars, $page) = @args{qw(vars page_id)};
# You can see this hook in action by loading page.cgi?id=example.html
if ($page eq 'example.html') {
$vars->{cgi_variables} = { Bugzilla->cgi->Vars };
}
#!/usr/bin/perl -w
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Testopia System.
#
# The Initial Developer of the Original Code is Greg Hendricks.
# Portions created by Greg Hendricks are Copyright (C) 2008
# Novell. All Rights Reserved.
#
# Contributor(s): Greg Hendricks <ghendricks@novell.com>
use strict;
my $vars = Bugzilla->hook_args->{vars};
$vars->{'example'} = 1
\ No newline at end of file
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Softwware.
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Bradley Baetz <bbaetz@everythingsolved.com>
use strict;
my $dbh = Bugzilla->dbh;
my $sth;
my $status = Bugzilla->hook_args->{'status'};
# Check that all users are Australian
$status->('example_check_au_user');
my $sth = $dbh->prepare("SELECT userid, login_name
FROM profiles
WHERE login_name NOT LIKE '%.au'");
$sth->execute;
my $seen_nonau = 0;
while (my ($userid, $login, $numgroups) = $sth->fetchrow_array) {
$status->('example_check_au_user_alert',
{ userid => $userid, login => $login },
'alert');
$seen_nonau = 1;
}
$status->('example_check_au_user_prompt') if $seen_nonau;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software.
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Bradley Baetz <bbaetz@everythingsolved.com>
use strict;
use Bugzilla;
my $cgi = Bugzilla->cgi;
my $dbh = Bugzilla->dbh;
my $status = Bugzilla->hook_args->{'status'};
if ($cgi->param('example_repair_au_user')) {
$status->('example_repair_au_user_start');
#$dbh->do("UPDATE profiles
# SET login_name = CONCAT(login_name, '.au')
# WHERE login_name NOT LIKE '%.au'");
$status->('example_repair_au_user_end');
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software.
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $config = Bugzilla->hook_args->{'config'};
# This will be accessible as "example_global_variable" in every
# template in Bugzilla. See Bugzilla/Template.pm's create() function
# for more things that you can set.
$config->{VARIABLES}->{example_global_variable} = sub { return 'value' };
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Matt Rogers.
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
# Matt Rogers <mattr@kde.org>
use strict;
use warnings;
use Bugzilla;
my %args = %{ Bugzilla->hook_args };
my ($vars, $file, $template) = $args{qw(vars file template)};
$vars->{'example'} = 1;
if ($file =~ m{^bug/show}) {
$vars->{'showing_a_bug'} = 1;
}
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by Everything Solved, Inc. are Copyright (C) 2008
# Everything Solved, Inc. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $error_map = Bugzilla->hook_args->{error_map};
$error_map->{'example_my_error'} = 10001;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by Everything Solved, Inc. are Copyright (C) 2007
# Everything Solved, Inc. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use warnings;
use Bugzilla;
my $dispatch = Bugzilla->hook_args->{dispatch};
$dispatch->{Example} = "extensions::example::lib::WSExample";
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example WebService Plugin
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by Everything Solved, Inc. are Copyright (C) 2007
# Everything Solved, Inc. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
# Colin Ogilvie <colin.ogilvie@gmail.com>
# This script does some code to return a hash about the Extension.
# You are required to return a hash containing the Extension version
# You can optionaally add any other values to the hash too, as long as
# they begin with an x_
#
# Eg:
# {
# 'version' => '0.1', # required
# 'x_name' => 'Example Extension'
# }
use strict;
no warnings qw(void); # Avoid "useless use of a constant in void context"
use Bugzilla::Constants;
{
'version' => BUGZILLA_VERSION,
'x_blah' => 'Hello....',
};
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical are Copyright (C) 2008 Canonical Ltd.
# All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
package extensions::example::lib::AuthLogin;
use strict;
use base qw(Bugzilla::Auth::Login);
use constant user_can_create_account => 0;
use Bugzilla::Constants;
# Always returns no data.
sub get_login_info {
return { failure => AUTH_NODATA };
}
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical are Copyright (C) 2008 Canonical Ltd.
# All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
package extensions::example::lib::AuthVerify;
use strict;
use base qw(Bugzilla::Auth::Verify);
use Bugzilla::Constants;
# A verifier that always fails.
sub check_credentials {
return { failure => AUTH_NO_SUCH_USER };
}
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by the Initial Developer are Copyright (C) 2009 the
# Initial Developer. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
package Bugzilla::ExampleHook;
use strict;
use base qw(Exporter);
our @EXPORT_OK = qw(
replace_bar
);
use Bugzilla::Util qw(html_quote);
# Used by bug-format_comment--see its code for an explanation.
sub replace_bar {
my $params = shift;
# $match is the first parentheses match in the $bar_match regex
# in bug-format_comment.pl. We get up to 10 regex matches as
# arguments to this function.
my $match = $params->{matches}->[0];
# Remember, you have to HTML-escape any data that you are returning!
$match = html_quote($match);
return qq{<a href="http://example.com/">$match</a>};
};
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
# Bradley Baetz <bbaetz@acm.org>
package extensions::example::lib::ConfigExample;
use strict;
use warnings;
use Bugzilla::Config::Common;
sub get_param_list {
my ($class) = @_;
my @param_list = (
{
name => 'example_string',
type => 't',
default => 'EXAMPLE',
},
);
return @param_list;
}
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by Everything Solved, Inc. are Copyright (C) 2007
# Everything Solved, Inc. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
package extensions::example::lib::WSExample;
use strict;
use warnings;
use base qw(Bugzilla::WebService);
use Bugzilla::Error;
# This can be called as Example.hello() from the WebService.
sub hello { return 'Hello!'; }
sub throw_an_error { ThrowUserError('example_my_error') }
1;
[%# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Bradley Baetz <bbaetz@everythingsolved.com>
#%]
[% IF san_tag == "example_check_au_user" %]
<em>EXAMPLE PLUGIN</em> - Checking for non-Australian users.
[% ELSIF san_tag == "example_check_au_user_alert" %]
User &lt;[% login FILTER html %]&gt; isn't Australian.
[% IF user.in_group('editusers') %]
<a href="editusers.cgi?id=[% userid FILTER none %]">Edit this user</a>.
[% END %]
[% ELSIF san_tag == "example_check_au_user_prompt" %]
<a href="sanitycheck.cgi?example_repair_au_user=1">Fix these users</a>.
[% ELSIF san_tag == "example_repair_au_user_start" %]
<em>EXAMPLE PLUGIN</em> - OK, would now make users Australian.
[% ELSIF san_tag == "example_repair_au_user_end" %]
<em>EXAMPLE PLUGIN</em> - Users would now be Australian.
[% END %]
[%#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2008
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s): Bradley Baetz <bbaetz@acm.org>
#%]
[%
title = "Example Extension"
desc = "Configure example extension"
%]
[% param_descs = {
example_string => "Example string",
}
%]
[%#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is Canonical Ltd.
# Portions created by Canonical Ltd. are Copyright (C) 2009
# Canonical Ltd. All Rights Reserved.
#
# Contributor(s):
# Max Kanat-Alexander <mkanat@bugzilla.org>
#%]
[% PROCESS global/header.html.tmpl
title = "Example Page"
%]
<p>Here's what you passed me:</p>
[% USE Dumper %]
<pre>
[% Dumper.dump_html(cgi_variables) %]
</pre>
[% PROCESS global/footer.html.tmpl %]
[%# Note that error messages should generally be indented four spaces, like
# below, because when Bugzilla translates an error message into plain
# text, it takes four spaces off the beginning of the lines.
#
# Note also that I prefixed my error name with "example", the name of my
# extension, so that I wouldn't conflict with other error names in
# Bugzilla or other extensions.
#%]
[% IF error == "example_my_error" %]
[% title = "Example Error Title" %]
This is the error message! It contains <em>some html</em>.
[% END %]
[%# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example Plugin.
#
# The Initial Developer of the Original Code is ITA Software
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s): Bradley Baetz <bbaetz@everythingsolved.com>
#%]
[% IF san_tag == "example_check_au_user" %]
<em>EXAMPLE PLUGIN</em> - Checking for non-Australian users.
[% ELSIF san_tag == "example_check_au_user_alert" %]
User &lt;[% login FILTER html %]&gt; isn't Australian.
[% IF user.in_group('editusers') %]
<a href="editusers.cgi?id=[% userid FILTER none %]">Edit this user</a>.
[% END %]
[% ELSIF san_tag == "example_check_au_user_prompt" %]
<a href="sanitycheck.cgi?example_repair_au_user=1">Fix these users</a>.
[% ELSIF san_tag == "example_repair_au_user_start" %]
<em>EXAMPLE PLUGIN</em> - OK, would now make users Australian.
[% ELSIF san_tag == "example_repair_au_user_end" %]
<em>EXAMPLE PLUGIN</em> - Users would now be Australian.
[% END %]
[%# Note that error messages should generally be indented four spaces, like
# below, because when Bugzilla translates an error message into plain
# text, it takes four spaces off the beginning of the lines.
#
# Note also that I prefixed my error name with "example", the name of my
# extension, so that I wouldn't conflict with other error names in
# Bugzilla or other extensions.
#%]
[% IF error == "example_my_error" %]
[% title = "Example Error Title" %]
This is the error message! It contains <em>some html</em>.
[% END %]
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Example WebService Plugin
#
# The Initial Developer of the Original Code is Everything Solved, Inc.
# Portions created by Everything Solved, Inc. are Copyright (C) 2007
# Everything Solved, Inc. All Rights Reserved.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
# This script does some code to return a version number. However,
# most plugins will probably just want to return a raw string.
# To do that, the only contents of the file should be the string
# on a single line, like:
#
# '1.2.3';
use strict;
no warnings qw(void); # Avoid "useless use of a constant in void context"
use Bugzilla::Constants;
BUGZILLA_VERSION;
/* The contents of this file are subject to the Mozilla Public
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is the Bugzilla Bug Tracking System.
*
* The Initial Developer of the Original Code is Netscape Communications
* Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s): Myk Melez <myk@mozilla.org>
*/
// When the XUL window finishes loading, load the RDF data into it.
window.addEventListener('load', loadData, false);
// The base URL of this Bugzilla installation; derived from the page's URL.
var gBaseURL = window.location.href.replace(/(jar:)?(.*?)duplicates\.(jar!|xul).*/, "$2");
function loadData()
{
// Loads the duplicates data as an RDF data source, attaches it to the tree,
// and rebuilds the tree to display the data.
netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
// Get the RDF service so we can use it to load the data source.
var rdfService =
Components
.classes["@mozilla.org/rdf/rdf-service;1"]
.getService(Components.interfaces.nsIRDFService);
// When a bug report loads in the content iframe, a 'load' event bubbles up
// to the browser window, which calls this load handler again, which reloads
// the RDF data, which causes the tree to lose the selection. To prevent
// this, we have to remove this handler.
window.removeEventListener('load', loadData, false);
// The URL of the RDF file; by default for performance a static file
// generated by collectstats.pl, but a call to duplicates.cgi if the page's
// URL contains parameters (so we can dynamically generate the RDF data
// based on those parameters).
var dataURL = gBaseURL + "data/duplicates.rdf";
if (window.location.href.search(/duplicates\.xul\?.+/) != -1)
dataURL = window.location.href.replace(/(duplicates\.jar!\/)?duplicates\.xul\?/, "duplicates.cgi?ctype=rdf&");
// Get the data source and add it to the XUL tree's database to populate
// the tree with the data.
var dataSource = rdfService.GetDataSource(dataURL);
// If we're using the static file, add an observer that detects failed loads
// (in case this installation isn't generating the file nightly) and redirects
// to the CGI version when loading of the static version fails.
if (window.location.href.search(/duplicates\.xul\?.+/) == -1)
{
var sink = dataSource.QueryInterface(Components.interfaces.nsIRDFXMLSink);
sink.addXMLSinkObserver(StaticDataSourceObserver);
}
// Add the data source to the tree, set the tree's "ref" attribute
// to the base URL of the data source, and rebuild the tree.
var resultsTree = document.getElementById('results-tree');
resultsTree.database.AddDataSource(dataSource);
resultsTree.setAttribute('ref', gBaseURL + "data/duplicates.rdf");
resultsTree.builder.rebuild();
}
function getBugURI()
{
var tree = document.getElementById('results-tree');
var index = tree.currentIndex;
netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
var builder = tree.builder.QueryInterface(Components.interfaces.nsIXULTreeBuilder);
var resource = builder.getResourceAtIndex(index);
return resource.Value;
}
function loadBugInWindow()
{
// Loads the selected bug in the browser window, replacing the duplicates report
// with the bug report.
var bugURI = getBugURI();
window.location = bugURI;
}
function loadBugInPane()
{
// Loads the selected bug in the iframe-based content pane that is part of
// this XUL document.
var splitter = document.getElementById('report-content-splitter');
var state = splitter.getAttribute('state');
if (state != "collapsed")
{
var bugURI = getBugURI();
var browser = document.getElementById('content-browser');
browser.setAttribute('src', bugURI);
}
}
var StaticDataSourceObserver = {
onBeginLoad: function(aSink) { } ,
onInterrupt: function(aSink) { } ,
onResume: function(aSink) { } ,
onEndLoad: function(aSink)
{
// Removes the observer from the data source so it doesn't stay around
// when duplicates.xul is reloaded from scratch.
netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
aSink.removeXMLSinkObserver(StaticDataSourceObserver);
} ,
onError: function(aSink, aStatus, aErrorMsg)
{
// Tries the dynamic data source since the static one failed to load.
netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
// Get the RDF service so we can use it to load the data source.
var rdfService =
Components
.classes["@mozilla.org/rdf/rdf-service;1"]
.getService(Components.interfaces.nsIRDFService);
// Remove the observer from the data source so it doesn't stay around
// when duplicates.xul is reloaded from scratch.
aSink.removeXMLSinkObserver(StaticDataSourceObserver);
// Remove the static data source from the tree.
var oldDataSource = aSink.QueryInterface(Components.interfaces.nsIRDFDataSource);
var resultsTree = document.getElementById('results-tree');
resultsTree.database.RemoveDataSource(oldDataSource);
// Munge the URL to point to the CGI and load the data source.
var dataURL = gBaseURL + "duplicates.cgi?ctype=rdf";
newDataSource = rdfService.GetDataSource(dataURL);
// Add the data source to the tree and rebuild the tree with the new data.
resultsTree.database.AddDataSource(newDataSource);
resultsTree.builder.rebuild();
}
};
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Keyword Chooser.
*
* The Initial Developer of the Original Code is America Online, Inc.
* Portions created by the Initial Developer are Copyright (C) 2004
* Mozilla Foundation. All Rights Reserved.
*
* Contributor(s):
* Christopher A. Aillon <christopher@aillon.com> (Original Author)
*
* ***** END LICENSE BLOCK ***** */
function KeywordChooser(aParent, aChooser, aAvail, aChosen, aValidKeywords)
{
// Initialization
this._parent = aParent;
this._chooser = aChooser;
this._available = aAvail;
this._chosen = aChosen;
this._validKeywords = aValidKeywords;
this.setInitialStyles();
// Register us, our properties, and our events
this._parent.chooser = this;
this._chooser.chooserElement = this._parent;
}
KeywordChooser.prototype =
{
// chooses the selected items
choose: function()
{
this._swapSelected(this._available, this._chosen);
},
unchoose: function()
{
this._swapSelected(this._chosen, this._available);
},
positionChooser: function()
{
if (this._positioned) return;
bz_overlayBelow(this._chooser, this._parent);
this._positioned = true;
},
setInitialStyles: function()
{
this._chooser.style.display = "none";
this._chooser.style.position = "absolute";
this._positioned = false;
},
open: function()
{
this._chooser.style.display = "";
this._available.style.display = "";
this._chosen.style.display = "";
this._parent.disabled = true;
this.positionChooser();
},
ok: function()
{
var len = this._chosen.options.length;
var text = "";
for (var i = 0; i < len; i++) {
text += this._chosen.options[i].text;
if (i != len - 1) {
text += ", ";
}
}
this._parent.value = text;
this._parent.title = text;
this.close();
},
cancel: function()
{
var chosentext = this._parent.value;
var chosenArray = new Array();
if (chosentext != ""){
chosenArray = chosentext.split(", ");
}
var availArray = new Array();
for (var i = 0; i < this._validKeywords.length; i++) {
if (!bz_isValueInArray(chosenArray, this._validKeywords[i])) {
availArray[availArray.length] = this._validKeywords[i];
}
}
bz_populateSelectFromArray(this._available, availArray, false, true);
bz_populateSelectFromArray(this._chosen, chosenArray, false, true);
this.close();
},
close: function()
{
this._chooser.style.display = "none";
this._parent.disabled = false;
},
_swapSelected: function(aSource, aTarget)
{
var kNothingSelected = -1;
while (aSource.selectedIndex != kNothingSelected) {
var option = aSource.options[aSource.selectedIndex];
aTarget.appendChild(option);
option.selected = false;
}
}
};
function InitializeKeywordChooser(aValidKeywords)
{
var keywords = document.getElementById("keywords");
var chooser = document.getElementById("keyword-chooser");
var avail = document.getElementById("keyword-list");
var chosen = document.getElementById("bug-keyword-list");
var chooserObj = new KeywordChooser(keywords, chooser, avail, chosen, aValidKeywords);
}
File mode changed from 100755 to 100644
File mode changed from 100644 to 100755
File mode changed from 100755 to 100644
// Adds to the target select object all elements in array that
// correspond to the elements selected in source.
// - array should be a array of arrays, indexed by product name. the
// array should contain the elements that correspont to that
// product. Example:
// var array = Array();
// array['ProductOne'] = [ 'ComponentA', 'ComponentB' ];
// updateSelect(array, source, target);
// - sel is a list of selected items, either whole or a diff
// depending on sel_is_diff.
// - sel_is_diff determines if we are sending in just a diff or the
// whole selection. a diff is used to optimize adding selections.
// - target should be the target select object.
// - single specifies if we selected a single item. if we did, no
// need to merge.
function updateSelect( array, sel, target, sel_is_diff, single, blank ) {
var i, j, comp;
// if single, even if it's a diff (happens when you have nothing
// selected and select one item alone), skip this.
if ( ! single ) {
// array merging/sorting in the case of multiple selections
if ( sel_is_diff ) {
// merge in the current options with the first selection
comp = merge_arrays( array[sel[0]], target.options, 1 );
// merge the rest of the selection with the results
for ( i = 1 ; i < sel.length ; i++ ) {
comp = merge_arrays( array[sel[i]], comp, 0 );
}
} else {
// here we micro-optimize for two arrays to avoid merging with a
// null array
comp = merge_arrays( array[sel[0]],array[sel[1]], 0 );
// merge the arrays. not very good for multiple selections.
for ( i = 2; i < sel.length; i++ ) {
comp = merge_arrays( comp, array[sel[i]], 0 );
}
}
} else {
// single item in selection, just get me the list
comp = array[sel[0]];
}
// save the selection in the target select so we can restore it later
var selections = new Array();
for ( i = 0; i < target.options.length; i++ )
if (target.options[i].selected) selections.push(target.options[i].value);
// clear select
target.options.length = 0;
// add empty "Any" value back to the list
if (blank) target.options[0] = new Option( blank, "" );
// load elements of list into select
for ( i = 0; i < comp.length; i++ ) {
target.options[target.options.length] = new Option( comp[i], comp[i] );
}
// restore the selection
for ( i=0 ; i<selections.length ; i++ )
for ( j=0 ; j<target.options.length ; j++ )
if (target.options[j].value == selections[i]) target.options[j].selected = true;
}
// Returns elements in a that are not in b.
// NOT A REAL DIFF: does not check the reverse.
// - a,b: arrays of values to be compare.
function fake_diff_array( a, b ) {
var newsel = new Array();
// do a boring array diff to see who's new
for ( var ia in a ) {
var found = 0;
for ( var ib in b ) {
if ( a[ia] == b[ib] ) {
found = 1;
}
}
if ( ! found ) {
newsel[newsel.length] = a[ia];
}
found = 0;
}
return newsel;
}
// takes two arrays and sorts them by string, returning a new, sorted
// array. the merge removes dupes, too.
// - a, b: arrays to be merge.
// - b_is_select: if true, then b is actually an optionitem and as
// such we need to use item.value on it.
function merge_arrays( a, b, b_is_select ) {
var pos_a = 0;
var pos_b = 0;
var ret = new Array();
var bitem, aitem;
// iterate through both arrays and add the larger item to the return
// list. remove dupes, too. Use toLowerCase to provide
// case-insensitivity.
while ( ( pos_a < a.length ) && ( pos_b < b.length ) ) {
if ( b_is_select ) {
bitem = b[pos_b].value;
} else {
bitem = b[pos_b];
}
aitem = a[pos_a];
// smaller item in list a
if ( aitem.toLowerCase() < bitem.toLowerCase() ) {
ret[ret.length] = aitem;
pos_a++;
} else {
// smaller item in list b
if ( aitem.toLowerCase() > bitem.toLowerCase() ) {
ret[ret.length] = bitem;
pos_b++;
} else {
// list contents are equal, inc both counters.
ret[ret.length] = aitem;
pos_a++;
pos_b++;
}
}
}
// catch leftovers here. these sections are ugly code-copying.
if ( pos_a < a.length ) {
for ( ; pos_a < a.length ; pos_a++ ) {
ret[ret.length] = a[pos_a];
}
}
if ( pos_b < b.length ) {
for ( ; pos_b < b.length; pos_b++ ) {
if ( b_is_select ) {
bitem = b[pos_b].value;
} else {
bitem = b[pos_b];
}
ret[ret.length] = bitem;
}
}
return ret;
}
// selectProduct reads the selection from f[productfield] and updates
// f.version, component and target_milestone accordingly.
// - f: a form containing product, component, varsion and
// target_milestone select boxes.
// globals (3vil!):
// - cpts, vers, tms: array of arrays, indexed by product name. the
// subarrays contain a list of names to be fed to the respective
// selectboxes. For bugzilla, these are generated with perl code
// at page start.
// - usetms: this is a global boolean that is defined if the
// bugzilla installation has it turned on. generated in perl too.
// - first_load: boolean, specifying if it's the first time we load
// the query page.
// - last_sel: saves our last selection list so we know what has
// changed, and optimize for additions.
function selectProduct( f , productfield, componentfield, blank ) {
// this is to avoid handling events that occur before the form
// itself is ready, which happens in buggy browsers.
if ( ( !f ) || ( ! f[productfield] ) ) {
return;
}
// Do nothing if no products are defined (this avoids the
// "a has no properties" error from merge_arrays function)
if (f[productfield].length == blank ? 1 : 0) {
return;
}
// if this is the first load and nothing is selected, no need to
// merge and sort all components; perl gives it to us sorted.
if ( ( first_load ) && ( f[productfield].selectedIndex == -1 ) ) {
first_load = 0;
return;
}
// turn first_load off. this is tricky, since it seems to be
// redundant with the above clause. It's not: if when we first load
// the page there is _one_ element selected, it won't fall into that
// clause, and first_load will remain 1. Then, if we unselect that
// item, selectProduct will be called but the clause will be valid
// (since selectedIndex == -1), and we will return - incorrectly -
// without merge/sorting.
first_load = 0;
// - sel keeps the array of products we are selected.
// - is_diff says if it's a full list or just a list of products that
// were added to the current selection.
// - single indicates if a single item was selected
// - selectedIndex is the index of the first selected item
// - selectedValue is the value of the first selected item
var sel = Array();
var is_diff = 0;
var single;
var selectedIndex = f[productfield].selectedIndex;
var selectedValue = f[productfield].options[selectedIndex].value;
// If nothing is selected, or the selected item is the "blank" value
// at the top of the list which represents all products on drop-down menus,
// then pick all products so we show all components.
if ( selectedIndex == -1 || !cpts[selectedValue])
{
for ( var i = blank ? 1 : 0 ; i < f[productfield].length ; i++ ) {
sel[sel.length] = f[productfield].options[i].value;
}
// If there is only one product, then only one product can be selected
single = ( sel.length == 1 );
} else {
for ( i = blank ? 1 : 0 ; i < f[productfield].length ; i++ ) {
if ( f[productfield].options[i].selected ) {
sel[sel.length] = f[productfield].options[i].value;
}
}
single = ( sel.length == 1 );
// save last_sel before we kill it
var tmp = last_sel;
last_sel = sel;
// this is an optimization: if we've added components, no need
// to remerge them; just merge the new ones with the existing
// options.
if ( ( tmp ) && ( tmp.length < sel.length ) ) {
sel = fake_diff_array(sel, tmp);
is_diff = 1;
}
}
// do the actual fill/update
updateSelect( cpts, sel, f[componentfield], is_diff, single, blank );
}
File mode changed from 100644 to 100755
File mode changed from 100644 to 100755
#!/usr/bin/perl -wT
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Initial Developer of the Original Code is Everything Solved.
# Portions created by Everything Solved are Copyright (C) 2007
# Everything Solved. All Rights Reserved.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
use strict;
use lib ".";
#################
# Initial Setup #
#################
# The order of these "use" statements is important--we have to have
# CGI before we have CGI::Carp. Without CGI::Carp, "use 5.008" will just throw
# an Internal Server Error if it fails, instead of showing a useful error
# message. And unless we're certain we're on 5.008, we shouldn't compile any
# Bugzilla code, particularly Bugzilla::Constants, because "use constant"
# might not exist.
#
# We can't use Bugzilla::CGI yet, because we're not sure our
# required perl modules are installed yet. However, CGI comes
# with perl.
use CGI;
use CGI::Carp qw(fatalsToBrowser);
use 5.008;
use Bugzilla::Constants;
require 5.008001 if ON_WINDOWS;
use Bugzilla::Install::Requirements;
use Bugzilla::Install::Util qw(install_string get_version_and_os);
local $| = 1;
my $cgi = new CGI;
$cgi->charset('UTF-8');
print $cgi->header();
print install_string('header', get_version_and_os());
######################
# Check Requirements #
######################
my $module_results = check_requirements(1);
print '</table>';
print '<pre>';
Bugzilla::Install::Requirements::print_module_instructions($module_results, 1);
print '</pre>';
print install_string('footer');
\ No newline at end of file
File mode changed from 100755 to 100644
File mode changed from 100755 to 100644
/* The contents of this file are subject to the Mozilla Public
* License Version 1.1 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is the Bugzilla Bug Tracking System.
*
* The Initial Developer of the Original Code is Everything Solved.
* Portions created by Everything Solved are Copyright (C) 2007
* Everything Solved. All Rights Reserved.
*
* Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
*/
.mod_requirements {
border-collapse: collapse;
border: none;
}
.mod_requirements td, .mod_requirements th {
border: 1px solid black;
padding: .2em;
}
.mod_requirements th.mod_header { border: none; }
.mod_name {
text-align: right;
}
/* If CSS is working, we don't display the "OK" column. Instead we have
colors and we explain them. */
td.mod_ok, th.mod_ok { display: none; }
.color_explanation { color: black; background-color: white }
.mod_ok { color: green; }
.mod_not_ok { color: red; }
\ No newline at end of file
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code are the Bugzilla tests.
#
# The Initial Developer of the Original Code is Jacob Steenhagen.
# Portions created by Jacob Steenhagen are
# Copyright (C) 2001 Jacob Steenhagen. All
# Rights Reserved.
#
# Contributor(s): Jacob Steenhagen <jake@bugzilla.org>
# David D. Kilzer <ddkilzer@kilzer.net>
#
#################
#Bugzilla Test 5#
#####no_tabs#####
use strict;
use lib 't';
use Support::Files;
use Support::Templates;
use File::Spec;
use Test::More tests => ( scalar(@Support::Files::testitems)
+ $Support::Templates::num_actual_files);
my @testitems = @Support::Files::testitems;
for my $path (@Support::Templates::include_paths) {
push(@testitems, map(File::Spec->catfile($path, $_),
Support::Templates::find_actual_files($path)));
}
foreach my $file (@testitems) {
open (FILE, "$file");
if (grep /\t/, <FILE>) {
ok(0, "$file contains tabs --WARNING");
} else {
ok(1, "$file has no tabs");
}
close (FILE);
}
exit 0;
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Albert Ting <alt@sonic.net>
#%]
[% PROCESS global/header.html.tmpl
title = "Classification deleted"
%]
Classification [% classification.name FILTER html %] deleted.<br>
<p>Back to the <a href="./">main [% terms.bugs %] page</a>
or <a href="editclassifications.cgi"> edit</a> more classifications.
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Albert Ting <alt@sonic.net>
#%]
[% PROCESS global/header.html.tmpl
title = "Adding new classification"
%]
OK, done.
<p>Back to the <a href="./">main [% terms.bugs %] page</a>,
<a href="editproducts.cgi?action=add&amp;classification=[% classification FILTER url_quote %]">add</a> products to this new classification,
or <a href="editclassifications.cgi"> edit</a> more classifications.
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Albert Ting <alt@sonic.net>
#%]
[% PROCESS global/header.html.tmpl
title = "Update classification"
%]
[% IF updated_sortkey %]
Updated sortkey.<br>
[% END %]
[% IF updated_description %]
Updated description.<br>
[% END %]
[% IF updated_classification %]
Updated classification name.<br>
[% END %]
<p>Back to the <a href="./">main [% terms.bugs %] page</a>
or <a href="editclassifications.cgi"> edit</a> more classifications.
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
#%]
[%# INTERFACE:
# comp: object; Bugzilla::Component object representing the component the
# user created.
# product: object; Bugzilla::Product object representing the product to
# which the component belongs.
#%]
[% title = BLOCK %]Adding new Component of Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
<p>The component '<a href="editcomponents.cgi?action=edit&amp;product=
[%- product.name FILTER url_quote %]&amp;component=[% comp.name FILTER url_quote %]">
[%- comp.name FILTER html %]</a>' has been created.</p>
[% PROCESS admin/components/footer.html.tmpl %]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
#%]
[%# INTERFACE:
# comp: object; Bugzilla::Component object representing the component the
# user deleted.
# product: object; Bugzilla::Product object representing the product to
# which the component belongs.
#%]
[% title = BLOCK %]Deleted Component '[% comp.name FILTER html %]' from Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
<p>
[% IF comp.bug_count %]
[% comp.bug_count FILTER none %]
[%- IF comp.bug_count > 1 %]
[%+ terms.bugs %]
[% ELSE %]
[%+ terms.bug %]
[% END %]
deleted.
</p><p>
All references to those deleted [% terms.bugs %] have been removed.
[% ELSE %]
No [% terms.bugs %] existed for the component.
[% END %]
</p>
<p>Flag inclusions and exclusions deleted.</p>
<p>Component '[% comp.name FILTER html %]' deleted.</p>
[% PROCESS admin/components/footer.html.tmpl
no_edit_component_link = 1
%]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
# Akamai Technologies <bugzilla-dev@akamai.com>
# Max Kanat-Alexander <mkanat@bugzilla.org>
#%]
[%# INTERFACE:
# changes: hashref; contains changes made to the component.
#
# comp: object; Bugzilla::Component object representing the component
# user updated.
# product: object; Bugzilla::Product object representing the product to
# which the component belongs.
#%]
[% title = BLOCK %]Updating Component '[% comp.name FILTER html %]' of Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
[% IF changes.name.defined %]
<p>Updated Component name to: '[% comp.name FILTER html %]'.</p>
[% END %]
[% IF changes.description.defined %]
<table>
<tr>
<td>Updated description to:</td>
<td>'[% comp.description FILTER html_light %]'</td>
</tr>
</table>
[% END %]
[% IF changes.initialowner.defined %]
<p>Updated Default Assignee to: '[% comp.default_assignee.login FILTER html %]'.</p>
[% END %]
[% IF changes.initialqacontact.defined %]
<p>
[% IF comp.default_qa_contact.id %]
Updated Default QA Contact to '[% comp.default_qa_contact.login FILTER html %]'.
[% ELSE %]
Removed Default QA Contact.
[% END %]
</p>
[% END %]
[% IF changes.cc_list.defined %]
[% IF comp.initial_cc.size %]
[% cc_list = [] %]
[% FOREACH cc_user = comp.initial_cc %]
[% cc_list.push(cc_user.login) %]
[% END %]
<p>Updated Default CC list to: [% cc_list.join(", ") FILTER html %].</p>
[% ELSE %]
<p>Removed the Default CC list.</p>
[% END %]
[% END %]
[% UNLESS changes.keys.size %]
<p>Nothing changed for component '[% comp.name FILTER html %]'.</p>
[% END %]
[% PROCESS admin/components/footer.html.tmpl %]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
#%]
[%# INTERFACE:
# value: string; the name of the newly created field value
# field: object; the field the value belongs to
#%]
[% title = BLOCK %]
New Value '[% value FILTER html %]' added to '[% field.description FILTER html %]'
([% field.name FILTER html %]) field
[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
<p>The value '<a title="Edit value '[% value FILTER html %]' of
for the '[% field.description FILTER html %]' field"
href="editvalues.cgi?action=edit&amp;field=
[%- field.name FILTER url_quote %]&amp;value=[% value FILTER url_quote %]">
[%- value FILTER html %]</a>' has been added as a valid choice for
the '[% field.description FILTER html %]' field.</p>
[% IF field.name == "bug_status" %]
You should now visit the <a href="editworkflow.cgi">status workflow page</a>
to include your new [% terms.bug %] status.
[% END %]
[% PROCESS admin/fieldvalues/footer.html.tmpl %]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
#%]
[%# INTERFACE:
# value: string; the field value that was deleted.
#
# field: object; the field the value was deleted from.
#
#%]
[% title = BLOCK %]
Deleted Value '[% value FILTER html %]' for the '[% field.description FILTER html %]'
([% field.name FILTER html %]) Field
[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
<p>Field Value '[% value FILTER html %]' deleted.</p>
[% PROCESS admin/fieldvalues/footer.html.tmpl
no_edit_link = 1
%]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
#%]
[%# INTERFACE:
#
# 'updated_XXX' variables are booleans, and are defined if the
# 'XXX' field was updated during the edit just being handled.
# Variables called just 'XXX' are strings, and are the _new_ contents
# of the fields.
#
# value & updated_value: the name of the field value
# sortkey & updated_sortkey: the field value sortkey
# field: object; the field that the value belongs to
# default_value_updated: boolean; whether the default value for
# this field has been updated
#%]
[% title = BLOCK %]
Updating Value '[% value FILTER html %]' of the '[% field.description FILTER html %]'
([% field.name FILTER html %]) Field
[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
[% IF updated_value %]
<p>Updated field value to: '[% value FILTER html %]'.</p>
[% IF default_value_updated %]
<p>Note that this value is the default for this field.
All references to the default value will now point to this new value.</p>
[% END %]
[% END %]
[% IF updated_sortkey %]
<p>Updated field value sortkey to: '[% sortkey FILTER html %]'.</p>
[% END %]
[% UNLESS (updated_sortkey || updated_value) %]
<p>Nothing changed for field value '[% value FILTER html %]'.</p>
[% END %]
[% PROCESS admin/fieldvalues/footer.html.tmpl %]
[% PROCESS global/footer.html.tmpl %]
[%# 1.0@bugzilla.org %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Dave Miller <justdave@syndicomm.com>
# Joel Peshkin <bugreport@peshkin.net>
# Jacob Steenhagen <jake@bugzilla.org>
# Vlad Dascalu <jocuri@softhome.net>
#%]
[%# INTERFACE:
# action: integer. Can be 1, 2 or 3, depending on the action
# performed:
# 1 - remove_explicit_members
# 2 - remove_explicit_members_regexp
# 3 - no conversion, just save the changes
# changes: boolean int. Is 1 if changes occurred.
# gid: integer. The ID of the group.
# name: the name of the product where removal is performed.
# regexp: the regexp according to which the update is performed.
#%]
[% IF (action == 1) %]
[% title = "Confirm: Remove All Explicit Members?" %]
[% ELSIF (action == 2) %]
[% title = "Confirm: Remove Explicit Members in the Regular Expression?" %]
[% ELSE %]
[% title = "Updating group hierarchy" %]
[% END %]
[% PROCESS global/header.html.tmpl %]
<p>
Checking....
[% IF changes %]
changed.
[% END %]
</p>
[% IF (action == 1) || (action == 2) %]
[% IF changes %]
<p>Group updated, please confirm removal:</p>
[% END %]
[% IF (action == 1) %]
<p>This option will remove all explicitly defined users
[% ELSIF regexp %]
<p>This option will remove all users included in the regular expression:
[% regexp FILTER html %]
[% ELSE %]
<p>
<b>There is no regular expression defined.</b>
No users will be removed.
</p>
[% END %]
[% IF ((action == 1) || regexp) %]
from group [% name FILTER html %].</p>
<p>
Generally, you will only need to do this when upgrading groups
created with [% terms.Bugzilla %] versions 2.16 and prior. Use
this option with <b>extreme care</b> and consult the documentation
for further information.
</p>
<form method="post" action="editgroups.cgi">
<input type="hidden" name="group" value="[% gid FILTER html %]">
[% IF (action == 2) %]
<input type="hidden" name="action" value="remove_all_regexp">
[% ELSE %]
<input type="hidden" name="action" value="remove_all">
[% END %]
<input name="confirm" type="submit" value="Confirm">
<p>Or <a href="editgroups.cgi">return to the Edit Groups page</a>.</p>
</form>
[% END %]
[% ELSE %]
[%# if we got this far, the admin doesn't want to convert, so just save
# their changes %]
[% IF changes %]
<p>Done.</p>
[% ELSE %]
<p>
You didn't change anything! If you really meant it, hit the <b>Back</b>
button and try again.
</p>
[% END %]
<p>Back to the <a href="editgroups.cgi">group list</a>.</p>
[% END %]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Dave Miller <justdave@syndicomm.com>
# Joel Peshkin <bugreport@peshkin.net>
# Jacob Steenhagen <jake@bugzilla.org>
# Vlad Dascalu <jocuri@softhome.net>
#%]
[%# INTERFACE:
# none
#%]
[% PROCESS global/header.html.tmpl
title = "Adding new group"
%]
<p>OK, done.</p>
<p><a href="editgroups.cgi?action=add">Add</a> another group or
go back to the <a href="editgroups.cgi">group list</a>.</p>
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Dave Miller <justdave@syndicomm.com>
# Joel Peshkin <bugreport@peshkin.net>
# Jacob Steenhagen <jake@bugzilla.org>
# Vlad Dascalu <jocuri@softhome.net>
#%]
[%# INTERFACE:
# name: string. The name of the group.
#%]
[% PROCESS global/header.html.tmpl
title = "Deleting group"
%]
<p>The group [% name FILTER html %] has been deleted.</p>
<p>Go back to the <a href="editgroups.cgi">group list</a>.
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Dave Miller <justdave@syndicomm.com>
# Joel Peshkin <bugreport@peshkin.net>
# Jacob Steenhagen <jake@bugzilla.org>
# Vlad Dascalu <jocuri@softhome.net>
# Max Kanat-Alexander <mkanat@bugzilla.org>
#%]
[%# INTERFACE:
# group: The Bugzilla::Group being modified.
# regexp: string. The regexp according to which the removal was performed.
# users: Array of Bugzilla::User objects who were removed from this group.
#%]
[% PROCESS global/header.html.tmpl
title = "Removing Explicit Group Membership" %]
<p><b>Removing explicit memberships[% IF regexp %] of users matching
'[% regexp FILTER html %]'[% END %]...</b></p>
[% FOREACH user = users %]
[% user.login FILTER html %] removed<br>
[% END %]
<p><b>Done</b>.</p>
<p>Back to the <a href="editgroups.cgi">group list</a>.</p>
[% PROCESS global/footer.html.tmpl %]
File mode changed from 100755 to 100644
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Terry Weissman <terry@mozilla.org>
# Vlad Dascalu <jocuri@softhome.net>
#%]
[%# INTERFACE:
# name: string; the name of the current keyword.
#%]
[% PROCESS global/header.html.tmpl
title = "Adding new keyword"
%]
<p>The keyword [% name FILTER html %] has been added.</p>
<p><a href="editkeywords.cgi">Edit existing keywords</a> or
<a href="editkeywords.cgi?action=add">add another keyword</a>.</p>
[% PROCESS global/footer.html.tmpl %]
File mode changed from 100755 to 100644
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Terry Weissman <terry@mozilla.org>
# Vlad Dascalu <jocuri@softhome.net>
# Max Kanat-Alexander <mkanat@bugzilla.org>
#%]
[%# INTERFACE:
# action: string; the current action (either "update" or "delete").
# keyword: A Bugzilla::Keyword object
#%]
[% IF action == "update" %]
[% title = "Update keyword"%]
[% status = "updated" %]
[% ELSIF action == "delete" %]
[% title = "Delete keyword" %]
[% status = "deleted" %]
[% END %]
[% PROCESS global/header.html.tmpl %]
Keyword [% keyword.name FILTER html %] [%+ status FILTER html %].
<p>
<b>After you have finished deleting or modifying keywords,
you need to rebuild the keyword cache.</b><br>
Warning: on a very large installation of [% terms.Bugzilla %],
this can take several minutes.
</p>
<p>
<b><a href="sanitycheck.cgi?rebuildkeywordcache=1">Rebuild
keyword cache</a></b>
</p>
<p><a href="editkeywords.cgi">Edit more keywords</a>.</p>
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
#%]
[%# INTERFACE:
# milestone: object; Bugzilla::Milestone object representing the
# milestone the user created.
#
# product: object; Bugzilla::Product object representing the product to
# which the milestone belongs.
#%]
[% title = BLOCK %]Adding new Milestone of Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
<p>The milestone '<a title="Edit milestone '[% milestone.name FILTER html %]' of
product '[% product.name FILTER html %]'"
href="editmilestones.cgi?action=edit&amp;product=
[%- product.name FILTER url_quote %]&amp;milestone=[% milestone.name FILTER url_quote %]">
[%- milestone.name FILTER html %]</a>' has been created.</p>
[% PROCESS admin/milestones/footer.html.tmpl %]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
# Frédéric Buclin <LpSolit@gmail.com>
#%]
[%# INTERFACE:
# product: object; Bugzilla::Product object representing the product to
# which the milestone belongs.
# milestone: object; Bugzilla::Milestone object representing the
# milestone the user deleted.
#%]
[% title = BLOCK %]Deleted Milestone '[% milestone.name FILTER html %]' of Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
<p>
[% IF milestone.bug_count %]
[% milestone.bug_count FILTER none %]
[% IF milestone.bug_count > 1 %]
[%+ terms.bugs %]
[% ELSE %]
[%+ terms.bug %]
[% END %]
reassigned to the default milestone.
[% ELSE %]
No [% terms.bugs %] were targetted at the milestone.
[% END %]
</p>
<p>Milestone '[% milestone.name FILTER html %]' deleted.</p>
[% PROCESS admin/milestones/footer.html.tmpl
no_edit_milestone_link = 1
%]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
#%]
[%# INTERFACE:
# milestone: object; the milestone being edited.
# product: object; Bugzilla::Product object representing the product to
# which the milestone belongs.
# changes: hashref; contains changes made to the milestone.
#%]
[% title = BLOCK %]Updating Milestone '[% milestone.name FILTER html %]' of Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
[% IF changes.value.defined %]
<p>Updated Milestone name to: '[% milestone.name FILTER html %]'.</p>
[% END %]
[% IF changes.sortkey.defined %]
<p>Updated Milestone sortkey to: '[% milestone.sortkey FILTER html %]'.</p>
[% END %]
[% UNLESS changes.value.defined || changes.sortkey.defined %]
<p>Nothing changed for milestone '[% milestone.name FILTER html %]'.</p>
[% END %]
[% PROCESS admin/milestones/footer.html.tmpl %]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Dave Miller <justdave@bugzilla.org>
# Frédéric Buclin <LpSolit@gmail.com>
#%]
[%
title = "Localization"
desc = "Define what languages you want made available to your users"
%]
[%# Get the list of available languages %]
[% available_languages = "unknown" %]
[% FOREACH param = params %]
[% IF param.name == "languages" %]
[% available_languages = param.extra_desc.available_languages FILTER html %]
[% END %]
[% END %]
[% param_descs = {
languages => "A comma-separated list of RFC 1766 language tags. These " _
"identify the languages in which you wish $terms.Bugzilla output " _
"to be displayed. Note that you must install the appropriate " _
"language pack before adding a language to this Param. The " _
"language used is the one in this list with the highest " _
"q-value in the user's Accept-Language header.<br><br> " _
"If the none of these languages are in the user's" _
" Accept-Language header, the first item in this list will be" _
" used. <br><br>" _
"Available languages: $available_languages"
} %]
File mode changed from 100755 to 100644
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# Contributor(s): Gabriel S. Oliveira <gabriel@async.com.br>
#%]
[%# INTERFACE:
# product: Bugzilla::Product object; the Product created.
#
#%]
[% title = BLOCK %]New Product '[% product.name FILTER html %]' Created[% END %]
[% PROCESS global/header.html.tmpl title = title %]
<br>
<div style='border: 1px red solid; padding: 1ex;'>
<b>You will need to
<a href="editcomponents.cgi?action=add&product=[% product.name FILTER url_quote %]">
add at least one component
</a> before you can enter [% terms.bugs %] against this product
</b>
</div>
[% PROCESS "admin/products/footer.html.tmpl" %]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# Contributor(s): Tiago R. Mello <timello@async.com.br>
#
#%]
[%# INTERFACE:
# product: Bugzilla::Product object; The product
#
#%]
[% title = BLOCK %]Product '[% product.name FILTER html %]' Deleted[% END %]
[% PROCESS global/header.html.tmpl title = title %]
[% IF product.bug_count %]
All references to deleted [% terms.bugs %] removed.
[% END %]
<p>
Components deleted.<br>
Versions deleted.<br>
Milestones deleted.
</p>
<p>
Group controls deleted.<br>
Flag inclusions and exclusions deleted.
</p>
<p>
Product [% product.name FILTER html %] deleted.
</p>
[% PROCESS admin/products/footer.html.tmpl
no_edit_product_link = 1
%]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# Contributor(s): Shane H. W. Travis <travis@sedsystems.ca>
#
#%]
[% PROCESS global/header.html.tmpl
title = "Default Preferences Updated"
%]
Your changes to the Default Preferences have been saved.<br>
<br>
Return to the <a
href="editsettings.cgi?action=load">Default Preferences</a> page.
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
#%]
[%# INTERFACE:
# product: object; Bugzilla::Product object representing the product to
# which the version belongs.
# version: object; Bugzilla::Version object representing the
# newly created version
#%]
[% title = BLOCK %]Adding new Version of Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
<p>The version '<a title="Edit version '[% version.name FILTER html %]' of product '
[%- product.name FILTER html %]'"
href="editversions.cgi?action=edit&amp;product=
[%- product.name FILTER url_quote %]&amp;version=[% version.name FILTER url_quote %]">
[%- version.name FILTER html %]</a>' has been created.</p>
[% PROCESS admin/versions/footer.html.tmpl %]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
#%]
[%# INTERFACE:
# product: object; Bugzilla::Product object representing the product to
# which the version belongs.
# version: object; Bugzilla::Version object representing the
# version the user deleted.
#%]
[% title = BLOCK %]Deleted Version '[% version.name FILTER html %]' of Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
<p>Version '[% version.name FILTER html %]' deleted.</p>
[% PROCESS admin/versions/footer.html.tmpl
no_edit_version_link = 1
%]
[% PROCESS global/footer.html.tmpl %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gavin Shelley <bugzilla@chimpychompy.org>
#%]
[%# INTERFACE:
# product: object; Bugzilla::Product object representing the product to
# which the version belongs.
# version: object; Bugzilla::Version object representing the
# version the user updated.
#
# updated: boolean; defined if the 'name' field was updated
#%]
[% title = BLOCK %]Updating Version '[% version.name FILTER html %]' of Product
'[% product.name FILTER html %]'[% END %]
[% PROCESS global/header.html.tmpl
title = title
%]
[% IF updated %]
<p>Updated Version name to: '[% version.name FILTER html %]'.</p>
[% ELSE %]
<p>Nothing changed for version '[% version.name FILTER html %]'.</p>
[% END %]
[% PROCESS admin/versions/footer.html.tmpl %]
[% PROCESS global/footer.html.tmpl %]
[%# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
# http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is Keyword Picker.
#
# The Initial Developer of the Original Code is America Online, Inc.
# Portions created by the Initial Developer are Copyright (C) 2004
# Mozilla Foundation. All Rights Reserved.
#
# Contributor(s):
# Christopher A. Aillon <christopher@aillon.com> (Original Author)
#
# ***** END LICENSE BLOCK *****
#%]
[%############################################################################%]
[%# Keyword Picker #%]
[%############################################################################%]
[%# #%]
[%# If you edit this file, you might also need to edit js/keyword-chooser.js #%]
[%# #%]
[%############################################################################%]
<div id="keyword-chooser" style="display: none">
<table>
<tr>
<td valign="top">
Available&nbsp;Keywords:<br>
<select id="keyword-list" size="5" multiple>
[% FOREACH kwd = valid_keywords %]
[% UNLESS sel_keywords && lsearch(sel_keywords, kwd) != -1 %]
<option value="[% kwd FILTER html %]">[% kwd FILTER html %]</option>
[% END %]
[% END %]
</select>
</td>
<td valign="middle">
<button onclick="document.getElementById('keyword-chooser').chooserElement.chooser.choose(); return false;">-></button><br>
<button onclick="document.getElementById('keyword-chooser').chooserElement.chooser.unchoose(); return false;"><-</button>
</td>
<td valign="top">
Bug&nbsp;Keywords:<br>
<select id="bug-keyword-list" size="5" multiple>
[% FOREACH kwd = valid_keywords %]
[% IF sel_keywords && lsearch(sel_keywords, kwd) != -1 %]
<option value="[% kwd FILTER html %]">[% kwd FILTER html %]</option>
[% END %]
[% END %]
</select>
</td>
<td valign="middle">
<button type="button" onclick="document.getElementById('keyword-chooser').chooserElement.chooser.ok(); return false">OK</button>
<br>
<button type="button" onclick="document.getElementById('keyword-chooser').chooserElement.chooser.cancel(); return false" style="margin-top:3px;">Cancel</button>
</td>
</tr>
</table>
</div>
<script type="text/javascript">
var validKeywords = new Array();
[% FOREACH kwd = valid_keywords %]
validKeywords[validKeywords.length] = "[% kwd FILTER html %]";
[% END %]
InitializeKeywordChooser(validKeywords);
</script>
[%# 1.0@bugzilla.org %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Gervase Markham <gerv@gerv.net>
#%]
[% USE Bugzilla %]
[% cgi = Bugzilla.cgi %]
[% IF cgi.param("help") %]
[% IF cgi.user_agent("Mozilla/5") %]
<style type="text/css">
.help {
border-style: solid;
border-color: #F0A000;
background-color: #FFFFFF;
padding: 5;
position: absolute;
}
</style>
<script type="text/javascript">
var currentHelp;
function initHelp() {
for (var i = 0; i < document.forms.length; i++) {
for (var j = 0; j < document.forms[i].elements.length; j++) {
[%# MS decided to add fieldsets to the elements array; and
# Mozilla decided to copy this brokenness. Grr.
#%]
if (document.forms[i].elements[j].tagName != 'FIELDSET') {
document.forms[i].elements[j].onmouseover = showHelp;
}
}
}
document.body.onclick = hideHelp;
}
function showHelp() {
hideHelp();
var newHelp = document.getElementById(this.name + '_help');
if (newHelp) {
currentHelp = newHelp;
var mytop = this.offsetTop;
var myleft = this.offsetLeft;
var myparent = this.offsetParent;
while (myparent.tagName != 'BODY') {
mytop = mytop + myparent.offsetTop;
myleft = myleft + myparent.offsetLeft;
myparent = myparent.offsetParent;
}
currentHelp.style.top = mytop + this.offsetHeight + 5 + "px";
currentHelp.style.left = myleft + "px";
currentHelp.style.display='';
}
}
function hideHelp() {
if (currentHelp) {
currentHelp.style.display='none';
}
}
</script>
[% END %]
[% ELSE %]
<script type="text/javascript">
<!--
[%# Avoid warnings by having a dummy function %]
function initHelp() {}
// -->
</script>
[% END %]
[%# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# The Initial Developer of the Original Code is Netscape Communications
# Corporation. Portions created by Netscape are
# Copyright (C) 1998 Netscape Communications Corporation. All
# Rights Reserved.
#
# Contributor(s): Myk Melez <myk@mozilla.org>
#%]
<?xml version="1.0"[% IF Param('utf8') %] encoding="UTF-8"[% END %]?>
<!-- [% template_version %] -->
<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:bz="http://www.bugzilla.org/rdf#"
xmlns:nc="http://home.netscape.com/NC-rdf#">
<bz:duplicates_report rdf:about="[% urlbase FILTER xml %]data/duplicates.rdf">
<bz:bugs>
<Seq>
[% FOREACH bug = bugs %]
<li>
<bz:bug rdf:about="[% urlbase FILTER xml %]show_bug.cgi?id=[% bug.id %]">
<bz:id nc:parseType="Integer">[% bug.id %]</bz:id>
<bz:resolution>[% bug.resolution FILTER html %]</bz:resolution>
<bz:duplicate_count nc:parseType="Integer">[% bug.count %]</bz:duplicate_count>
<bz:duplicate_delta nc:parseType="Integer">[% bug.delta %]</bz:duplicate_delta>
<bz:component>[% bug.component FILTER html %]</bz:component>
<bz:severity>[% bug.bug_severity FILTER html %]</bz:severity>
<bz:os>[% bug.op_sys FILTER html %]</bz:os>
<bz:target_milestone>[% bug.target_milestone FILTER html %]</bz:target_milestone>
<bz:summary>[% bug.short_desc FILTER html %]</bz:summary>
</bz:bug>
</li>
[% END %]
</Seq>
</bz:bugs>
</bz:duplicates_report>
</RDF>
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Initial Developer of the Original Code is Everything Solved.
# Portions created by Everything Solved are Copyright (C) 2007
# Everything Solved. All Rights Reserved.
#
# The Original Code is the Bugzilla Bug Tracking System.
#
# Contributor(s): Max Kanat-Alexander <mkanat@bugzilla.org>
# This is just like strings.txt.pl, but for HTML templates (used by
# setup.cgi).
%strings = (
checking_dbd => '<tr><th colspan="4" class="mod_header">Database Modules</th></tr>',
checking_optional => '<tr><th colspan="4" class="mod_header">Optional Modules</th></tr>',
checking_modules => <<END_HTML
<h2>Perl Modules</h2>
<div style="color: white; background-color: white">
<p class="color_explanation">Rows that look <span class="mod_ok">like
this</span> mean that you have a good version of that module installed.
Rows that look <span class="mod_not_ok">like this</span> mean that you
either don't have that module installed, or the version you have
installed is too old.</p>
</div>
<table class="mod_requirements" border="1">
<tr>
<th class="mod_name">Package</th>
<th>Version Required</th> <th>Version Found</th>
<th class="mod_ok">OK?</th>
</tr>
END_HTML
,
footer => "</div></body></html>",
# This is very simple. It doesn't support the skinning system.
header => <<END_HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Installation and Setup for Bugzilla ##bz_ver##</title>
<link href="skins/standard/global.css" rel="stylesheet" type="text/css" />
<link href="skins/standard/setup.css" rel="stylesheet" type="text/css" />
</head>
<body id="bugzilla-installation">
<h1>Installation and Setup for Bugzilla ##bz_ver##</h1>
<div id="bugzilla-body">
<p><strong>Perl Version</strong>: ##perl_ver##
<strong>OS</strong>: ##os_name## ##os_ver##</p>
END_HTML
,
module_details => <<END_HTML
<tr class="##row_class##">
<td class="mod_name">##package##</td>
<td class="mod_wanted">##wanted##</td>
<td class="mod_found">##found##</td>
<td class="mod_ok">##ok##</td>
</tr>
END_HTML
,
module_found => '##ver##',
);
1;
# -*- Mode: perl; indent-tabs-mode: nil -*-
#
# The contents of this file are subject to the Mozilla Public
# License Version 1.1 (the "License"); you may not use this file
# except in compliance with the License. You may obtain a copy of
# the License at http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
# implied. See the License for the specific language governing
# rights and limitations under the License.
#
# The Original Code are the Bugzilla tests.
#
# The Initial Developer of the Original Code is Jacob Steenhagen.
# Portions created by Jacob Steenhagen are
# Copyright (C) 2001 Jacob Steenhagen. All
# Rights Reserved.
#
# Contributor(s): Gervase Markham <gerv@gerv.net>
# Joel Peshkin <bugreport@peshkin.net>
# Important! The following classes of directives are excluded in the test,
# and so do not need to be added here. Doing so will cause warnings.
# See 008filter.t for more details.
#
# Comments - [%#...
# Directives - [% IF|ELSE|UNLESS|FOREACH...
# Assignments - [% foo = ...
# Simple literals - [% " selected" ...
# Values always used for numbers - [% (i|j|k|n|count) %]
# Params - [% Param(...
# Safe functions - [% (time2str)...
# Safe vmethods - [% foo.size %] [% foo.length %]
# [% foo.push() %]
# TT loop variables - [% loop.count %]
# Already-filtered stuff - [% wibble FILTER html %]
# where the filter is one of html|csv|js|url_quote|quoteUrls|time|uri|xml|none
%::safe = (
);
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment