2 # BEGIN BPS TAGGED BLOCK {{{
6 # This software is Copyright (c) 1996-2019 Best Practical Solutions, LLC
7 # <sales@bestpractical.com>
9 # (Except where explicitly superseded by other copyright notices)
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
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.
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.
31 # CONTRIBUTION SUBMISSION POLICY:
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.)
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.
48 # END BPS TAGGED BLOCK }}}
52 # fix lib paths, some may be relative
53 BEGIN { # BEGIN RT CMD BOILERPLATE
56 my @libs = ("@RT_LIB_PATH@", "@LOCAL_LIB_PATH@");
60 unless ( File::Spec->file_name_is_absolute($lib) ) {
61 $bin_path ||= ( File::Spec->splitpath(Cwd::abs_path(__FILE__)) )[1];
62 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
73 "help|h", "dryrun", "time=i", "epoch=i", "all", "log=s"
78 print Pod::Usage::pod2usage(-verbose => 2);
83 require RT::Interface::CLI;
84 RT::Interface::CLI->import(qw{ loc });
86 # Load the config file
89 # adjust logging to the screen according to options
90 RT->Config->Set( LogToSTDERR => $opts{log} ) if $opts{log};
92 # Connect to the database and get RT::SystemUser and RT::Nobody loaded
95 require RT::Dashboard::Mailer;
96 RT::Dashboard::Mailer->MailDashboards(
98 DryRun => $opts{dryrun},
99 Time => ($opts{time} || $opts{epoch} || time), # epoch is the old-style
105 rt-email-dashboards - Send email dashboards
109 rt-email-dashboards [options]
113 This tool will send users email based on how they have subscribed to
114 dashboards. A dashboard is a set of saved searches, the subscription controls
115 how often that dashboard is sent and how it's displayed.
117 Each subscription has an hour, and possibly day of week or day of month. These
118 are taken to be in the user's timezone if available, UTC otherwise.
122 You'll need to have cron run this script every hour. Here's an example crontab
125 0 * * * * @RT_SBIN_PATH_R@/rt-email-dashboards
127 This will run the script every hour on the hour. This may need some further
128 tweaking to be run as the correct user.
132 This tool supports a few options. Most are for debugging.
140 Display this documentation
144 Figure out which dashboards would be sent, but don't actually generate or email
149 Instead of using the current time to figure out which dashboards should be
150 sent, use SECONDS (usually since midnight Jan 1st, 1970, so C<1192216018> would
151 be Oct 12 19:06:58 GMT 2007).
153 =item --epoch SECONDS
155 Back-compat for --time SECONDS.
159 Ignore subscription frequency when considering each dashboard (should only be
160 used with --dryrun for testing and debugging)
164 Adjust LogToSTDERR config option