rt/sbin/rt-preferences-viewer.in

   1 #!@PERL@
   2 # BEGIN BPS TAGGED BLOCK {{{
   3 #
   4 # COPYRIGHT:
   5 #
   6 # This software is Copyright (c) 1996-2018 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 }}}
  49 use strict;
  50 use warnings;
  51
  52 # fix lib paths, some may be relative
  53 BEGIN { # BEGIN RT CMD BOILERPLATE
  54     require File::Spec;
  55     require Cwd;
  56     my @libs = ("@RT_LIB_PATH@", "@LOCAL_LIB_PATH@");
  57     my $bin_path;
  58
  59     for my $lib (@libs) {
  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 );
  63         }
  64         unshift @INC, $lib;
  65     }
  66
  67 }
  68
  69 use RT::Interface::CLI qw(Init);
  70 my %opt;
  71 Init( \%opt, 'user|u=s', 'option|o=s' );
  72
  73 require RT::Attributes;
  74 my $attrs = RT::Attributes->new( RT->SystemUser );
  75 $attrs->Limit( FIELD => 'Name', VALUE => 'Pref-RT::System-1' );
  76 $attrs->Limit( FIELD => 'ObjectType', VALUE => 'RT::User' );
  77
  78 if ($opt{user}) {
  79     my $user = RT::User->new( RT->SystemUser );
  80     my ($val, $msg) = $user->Load($opt{user});
  81     unless ($val) {
  82         RT->Logger->error("Unable to load $opt{user}: $msg");
  83         exit(1);
  84     }
  85     $attrs->Limit( FIELD => 'ObjectId', VALUE => $user->Id );
  86 }
  87
  88 use Data::Dumper;
  89 $Data::Dumper::Terse = 1;
  90
  91 while (my $attr = $attrs->Next ) {
  92     my $user = RT::User->new( RT->SystemUser );
  93     my ($val, $msg) = $user->Load($attr->ObjectId);
  94     unless ($val) {
  95         RT->Logger->warn("Unable to load User ".$attr->ObjectId." $msg");
  96         next;
  97     }
  98     next if $user->Disabled;
  99
 100     my $content = $attr->Content;
 101     if ( my $config_name = $opt{option} ) {
 102         if ( exists $content->{$config_name} ) {
 103             my $setting = $content->{$config_name};
 104             print $user->Name, "\t$config_name: $setting\n";
 105         }
 106     } else {
 107         print $user->Name, " => ", Dumper($content);
 108     }
 109
 110 }
 111
 112 __END__
 113
 114 =head1 NAME
 115
 116 rt-preferences-viewer - show user defined preferences
 117
 118 =head1 SYNOPSIS
 119
 120     rt-preferences-viewer
 121
 122     rt-preferences-viewer --user=falcone
 123         show only the falcone user's preferences
 124
 125     rt-preferences-viewer --option=EmailFrequency
 126         show users who have set the EmailFrequence config option
 127
 128 =head1 DESCRIPTION
 129
 130 This script shows user settings of preferences.  If a user is using the system
 131 default, it will not be listed.  You can limit to a user name or id or to users
 132 with a particular option set.