1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
#!/usr/bin/perl
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This Source Code Form is "Incompatible With Secondary Licenses", as
# defined by the Mozilla Public License, v. 2.0.
use 5.10.1;
use strict;
use warnings;
use lib qw(. lib);
use Bugzilla;
use Bugzilla::Constants;
use Bugzilla::Error;
use Bugzilla::User;
use Bugzilla::Mailer;
use Getopt::Long;
use Pod::Usage;
my $verbose = 0; # Return all comments if true, else errors only.
my $login = ''; # Login name of the user which is used to call sanitycheck.cgi.
my $help = 0; # Has user asked for help on this script?
my $errors_to = 0; # send mail to error contact instead of user
my @params;
my $result = GetOptions(
'verbose' => \$verbose,
'login=s' => \$login,
'help|h|?' => \$help,
'errors_to' => \$errors_to,
'param=s' => \@params,
);
pod2usage({-verbose => 1, -exitval => 1}) if $help;
# Be sure a login name if given.
$login || ThrowUserError('invalid_username');
my $user = new Bugzilla::User({name => $login})
|| ThrowUserError('invalid_username', {name => $login});
my $cgi = Bugzilla->cgi;
my $template = Bugzilla->template;
# Authenticate using this user account.
Bugzilla->set_user($user);
# Pass this param to sanitycheck.cgi.
$cgi->param('verbose', $verbose);
foreach my $param (@params) {
$cgi->param($param, 1);
}
require 'sanitycheck.cgi';
# Now it's time to send an email to the user if there is something to notify.
if ($cgi->param('output')) {
my $message;
my $vars = {};
$vars->{'addressee'}
= $errors_to ? Bugzilla->params->{mail_errors_to} : $user->email;
$vars->{'output'} = $cgi->param('output');
$vars->{'error_found'} = $cgi->param('error_found') ? 1 : 0;
$template->process('email/sanitycheck.txt.tmpl', $vars, \$message)
|| ThrowTemplateError($template->error());
MessageToMTA($message);
}
__END__
=head1 NAME
sanitycheck.pl - Perl script to perform a sanity check at the command line
=head1 SYNOPSIS
./sanitycheck.pl [--help]
./sanitycheck.pl [--verbose] --login <user@domain.com>
=head1 OPTIONS
=over
=item B<--help>
Displays this help text
=item B<--verbose>
Causes this script to be more verbose in its output. Without this option,
the script will return only errors. With the option, the script will append
all output to the email.
=item B<--login>
This should be passed the email address of a user that is capable of
running the Sanity Check process, a user with the editcomponents priv. This
user will receive an email with the results of the script run.
=item B<--errors_to>
Instead of mailing --login, mail the 'mail_errors_to' address.
=item B<--param>
Set parameters to ae.g. If you wanted to fix repair_bugs_fulltext
pss to sanitycheck.cgi.
e.g. If you wanted to fix bug full text records
--param repair_bugs_fulltext
Can be set multiple times.
=back
=head1 DESCRIPTION
This script provides a way of running a 'Sanity Check' on the database
via either a CLI or cron. It is equivalent to calling sanitycheck.cgi
via a web browser.
|
GitWeb