Initial commit 4.0.5-3
[usit-rt.git] / sbin / rt-email-dashboards
CommitLineData
84fb5b46
MKG
1#!/usr/bin/perl
2# BEGIN BPS TAGGED BLOCK {{{
3#
4# COPYRIGHT:
5#
6# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
7# <sales@bestpractical.com>
8#
9# (Except where explicitly superseded by other copyright notices)
10#
11#
12# LICENSE:
13#
14# This work is made available to you under the terms of Version 2 of
15# the GNU General Public License. A copy of that license should have
16# been provided with this software, but in any event can be snarfed
17# from www.gnu.org.
18#
19# This work is distributed in the hope that it will be useful, but
20# WITHOUT ANY WARRANTY; without even the implied warranty of
21# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22# General Public License for more details.
23#
24# You should have received a copy of the GNU General Public License
25# along with this program; if not, write to the Free Software
26# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
27# 02110-1301 or visit their web page on the internet at
28# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
29#
30#
31# CONTRIBUTION SUBMISSION POLICY:
32#
33# (The following paragraph is not intended to limit the rights granted
34# to you to modify and distribute this software under the terms of
35# the GNU General Public License and is only of importance to you if
36# you choose to contribute your changes and enhancements to the
37# community by submitting them to Best Practical Solutions, LLC.)
38#
39# By intentionally submitting any modifications, corrections or
40# derivatives to this work, or any other work intended for use with
41# Request Tracker, to Best Practical Solutions, LLC, you confirm that
42# you are the copyright holder for those contributions and you grant
43# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
44# royalty-free, perpetual, license to use, copy, create derivative
45# works based on those contributions, and sublicense and distribute
46# those contributions and any derivatives thereof.
47#
48# END BPS TAGGED BLOCK }}}
49use strict;
50use warnings;
51
52# fix lib paths, some may be relative
53BEGIN {
54 require File::Spec;
55 my @libs = ("lib", "local/lib");
56 my $bin_path;
57
58 for my $lib (@libs) {
59 unless ( File::Spec->file_name_is_absolute($lib) ) {
60 unless ($bin_path) {
61 if ( File::Spec->file_name_is_absolute(__FILE__) ) {
62 $bin_path = ( File::Spec->splitpath(__FILE__) )[1];
63 }
64 else {
65 require FindBin;
66 no warnings "once";
67 $bin_path = $FindBin::Bin;
68 }
69 }
70 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
71 }
72 unshift @INC, $lib;
73 }
74
75}
76
77# Read in the options
78my %opts;
79use Getopt::Long;
80GetOptions( \%opts,
81 "help|h", "dryrun", "time=i", "epoch=i", "all"
82);
83
84if ($opts{'help'}) {
85 require Pod::Usage;
86 print Pod::Usage::pod2usage(-verbose => 2);
87 exit;
88}
89
90require RT;
91require RT::Interface::CLI;
92RT::Interface::CLI->import(qw{ CleanEnv loc });
93
94# Clean out all the nasties from the environment
95CleanEnv();
96
97# Load the config file
98RT::LoadConfig();
99
100# Connect to the database and get RT::SystemUser and RT::Nobody loaded
101RT::Init();
102
103require RT::Dashboard::Mailer;
104RT::Dashboard::Mailer->MailDashboards(
105 All => $opts{all},
106 DryRun => $opts{dryrun},
107 Time => ($opts{time} || $opts{epoch} || time), # epoch is the old-style
108 Opts => \%opts,
109);
110
111=head1 NAME
112
113rt-email-dashboards - Send email dashboards
114
115=head1 SYNOPSIS
116
117 rt-email-dashboards [options]
118
119=head1 DESCRIPTION
120
121This tool will send users email based on how they have subscribed to
122dashboards. A dashboard is a set of saved searches, the subscription controls
123how often that dashboard is sent and how it's displayed.
124
125Each subscription has an hour, and possibly day of week or day of month. These
126are taken to be in the user's timezone if available, UTC otherwise.
127
128=head1 SETUP
129
130You'll need to have cron run this script every hour. Here's an example crontab
131entry to do this.
132
133 0 * * * * /usr/bin/perl /opt/rt4/local/sbin/rt-email-dashboards
134
135This will run the script every hour on the hour. This may need some further
136tweaking to be run as the correct user.
137
138=head1 OPTIONS
139
140This tool supports a few options. Most are for debugging.
141
142=over 8
143
144=item -h
145
146=item --help
147
148Display this documentation
149
150=item --dryrun
151
152Figure out which dashboards would be sent, but don't actually generate or email
153any of them
154
155=item --time SECONDS
156
157Instead of using the current time to figure out which dashboards should be
158sent, use SECONDS (usually since midnight Jan 1st, 1970, so C<1192216018> would
159be Oct 12 19:06:58 GMT 2007).
160
161=item --epoch SECONDS
162
163Back-compat for --time SECONDS.
164
165=item --all
166
167Ignore subscription frequency when considering each dashboard (should only be
168used with --dryrun for testing and debugging)
169
170=back
171
172=cut
173