Merge branch 'master' of git.uio.no:usit-rt
[usit-rt.git] / sbin / rt-email-dashboards
CommitLineData
84fb5b46
MKG
1#!/usr/bin/perl
2# BEGIN BPS TAGGED BLOCK {{{
3#
4# COPYRIGHT:
5#
320f0092 6# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
84fb5b46
MKG
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
af59614d 53BEGIN { # BEGIN RT CMD BOILERPLATE
84fb5b46 54 require File::Spec;
af59614d 55 require Cwd;
84fb5b46
MKG
56 my @libs = ("lib", "local/lib");
57 my $bin_path;
58
59 for my $lib (@libs) {
60 unless ( File::Spec->file_name_is_absolute($lib) ) {
af59614d 61 $bin_path ||= ( File::Spec->splitpath(Cwd::abs_path(__FILE__)) )[1];
84fb5b46
MKG
62 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
63 }
64 unshift @INC, $lib;
65 }
66
67}
68
69# Read in the options
70my %opts;
71use Getopt::Long;
72GetOptions( \%opts,
73 "help|h", "dryrun", "time=i", "epoch=i", "all"
74);
75
76if ($opts{'help'}) {
77 require Pod::Usage;
78 print Pod::Usage::pod2usage(-verbose => 2);
79 exit;
80}
81
82require RT;
83require RT::Interface::CLI;
84RT::Interface::CLI->import(qw{ CleanEnv loc });
85
84fb5b46
MKG
86# Load the config file
87RT::LoadConfig();
88
89# Connect to the database and get RT::SystemUser and RT::Nobody loaded
90RT::Init();
91
af59614d
MKG
92# Clean out all the nasties from the environment
93CleanEnv();
94
84fb5b46
MKG
95require RT::Dashboard::Mailer;
96RT::Dashboard::Mailer->MailDashboards(
97 All => $opts{all},
98 DryRun => $opts{dryrun},
99 Time => ($opts{time} || $opts{epoch} || time), # epoch is the old-style
100 Opts => \%opts,
101);
102
103=head1 NAME
104
105rt-email-dashboards - Send email dashboards
106
107=head1 SYNOPSIS
108
109 rt-email-dashboards [options]
110
111=head1 DESCRIPTION
112
113This tool will send users email based on how they have subscribed to
114dashboards. A dashboard is a set of saved searches, the subscription controls
115how often that dashboard is sent and how it's displayed.
116
117Each subscription has an hour, and possibly day of week or day of month. These
118are taken to be in the user's timezone if available, UTC otherwise.
119
120=head1 SETUP
121
122You'll need to have cron run this script every hour. Here's an example crontab
123entry to do this.
124
125 0 * * * * /usr/bin/perl /opt/rt4/local/sbin/rt-email-dashboards
126
127This will run the script every hour on the hour. This may need some further
128tweaking to be run as the correct user.
129
130=head1 OPTIONS
131
132This tool supports a few options. Most are for debugging.
133
134=over 8
135
136=item -h
137
138=item --help
139
140Display this documentation
141
142=item --dryrun
143
144Figure out which dashboards would be sent, but don't actually generate or email
145any of them
146
147=item --time SECONDS
148
149Instead of using the current time to figure out which dashboards should be
150sent, use SECONDS (usually since midnight Jan 1st, 1970, so C<1192216018> would
151be Oct 12 19:06:58 GMT 2007).
152
153=item --epoch SECONDS
154
155Back-compat for --time SECONDS.
156
157=item --all
158
159Ignore subscription frequency when considering each dashboard (should only be
160used with --dryrun for testing and debugging)
161
162=back
163
164=cut
165