BugsSite/sanitycheck.pl

   1 #!/usr/bin/env perl -w
   2 # -*- Mode: perl; indent-tabs-mode: nil -*-
   3 #
   4 # The contents of this file are subject to the Mozilla Public
   5 # License Version 1.1 (the "License"); you may not use this file
   6 # except in compliance with the License. You may obtain a copy of
   7 # the License at http://www.mozilla.org/MPL/
   8 #
   9 # Software distributed under the License is distributed on an "AS
  10 # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  11 # implied. See the License for the specific language governing
  12 # rights and limitations under the License.
  13 #
  14 # The Original Code is the Bugzilla Bug Tracking System.
  15 #
  16 # The Initial Developer of the Original Code is Frédéric Buclin.
  17 # Portions created by Frédéric Buclin are Copyright (C) 2007
  18 # Frédéric Buclin. All Rights Reserved.
  19 #
  20 # Contributor(s): Frédéric Buclin <LpSolit@gmail.com>
  21
  22 use strict;
  23
  24 use lib qw(. lib);
  25
  26 use Bugzilla;
  27 use Bugzilla::Constants;
  28 use Bugzilla::Error;
  29 use Bugzilla::User;
  30 use Bugzilla::Mailer;
  31
  32 use Getopt::Long;
  33 use Pod::Usage;
  34
  35 my $verbose = 0; # Return all comments if true, else errors only.
  36 my $login = '';  # Login name of the user which is used to call sanitycheck.cgi.
  37 my $help = 0;    # Has user asked for help on this script?
  38
  39 my $result = GetOptions('verbose'  => \$verbose,
  40                         'login=s'  => \$login,
  41                         'help|h|?' => \$help);
  42
  43 pod2usage({-verbose => 1, -exitval => 1}) if $help;
  44
  45 Bugzilla->usage_mode(USAGE_MODE_CMDLINE);
  46
  47 # Be sure a login name if given.
  48 $login || ThrowUserError('invalid_username');
  49
  50 my $user = new Bugzilla::User({ name => $login })
  51   || ThrowUserError('invalid_username', { name => $login });
  52
  53 my $cgi = Bugzilla->cgi;
  54 my $template = Bugzilla->template;
  55
  56 # Authenticate using this user account.
  57 Bugzilla->set_user($user);
  58
  59 # Pass this param to sanitycheck.cgi.
  60 $cgi->param('verbose', $verbose);
  61
  62 require 'sanitycheck.cgi';
  63
  64 # Now it's time to send an email to the user if there is something to notify.
  65 if ($cgi->param('output')) {
  66     my $message;
  67     my $vars = {};
  68     $vars->{'addressee'} = $user->email;
  69     $vars->{'output'} = $cgi->param('output');
  70     $vars->{'error_found'} = $cgi->param('error_found') ? 1 : 0;
  71
  72     $template->process('email/sanitycheck.txt.tmpl', $vars, \$message)
  73       || ThrowTemplateError($template->error());
  74
  75     MessageToMTA($message);
  76 }
  77
  78
  79 __END__
  80
  81 =head1 NAME
  82
  83 sanitycheck.pl - Perl script to perform a sanity check at the command line
  84
  85 =head1 SYNOPSIS
  86
  87  ./sanitycheck.pl [--help]
  88  ./sanitycheck.pl [--verbose] --login <user@domain.com>
  89
  90 =head1 OPTIONS
  91
  92 =over
  93
  94 =item B<--help>
  95
  96 Displays this help text
  97
  98 =item B<--verbose>
  99
 100 Causes this script to be more verbose in its output. Without this option,
 101 the script will return only errors. With the option, the script will append
 102 all output to the email.
 103
 104 =item B<--login>
 105
 106 This should be passed the email address of a user that is capable of
 107 running the Sanity Check process, a user with the editcomponents priv. This
 108 user will receive an email with the results of the script run.
 109
 110 =back
 111
 112 =head1 DESCRIPTION
 113
 114 This script provides a way of running a 'Sanity Check' on the database
 115 via either a CLI or cron. It is equivalent to calling sanitycheck.cgi
 116 via a web broswer.