blob: 592069a9c47427c3560ff2f816ac326c536497e6 [file] [log] [blame]
#!/usr/bin/env 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
# 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) 2007
# Frédéric Buclin. All Rights Reserved.
# Contributor(s): Frédéric Buclin <>
use strict;
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 $result = GetOptions('verbose' => \$verbose,
'login=s' => \$login,
'help|h|?' => \$help);
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.
# Pass this param to sanitycheck.cgi.
$cgi->param('verbose', $verbose);
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'} = $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());
=head1 NAME - Perl script to perform a sanity check at the command line
./ [--help]
./ [--verbose] --login <>
=head1 OPTIONS
=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.
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 broswer.