Merge branch 'master' of git.uio.no:usit-rt
[usit-rt.git] / sbin / rt-preferences-viewer
1 #!/usr/bin/perl
2 # BEGIN BPS TAGGED BLOCK {{{
3 #
4 # COPYRIGHT:
5 #
6 # This software is Copyright (c) 1996-2014 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 = ("lib", "local/lib");
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 BEGIN {
70     use RT;
71     RT::LoadConfig();
72     RT::Init();
73 };
74
75 use Getopt::Long;
76 my %opt;
77 GetOptions( \%opt, 'help|h', 'user|u=s', 'option|o=s' );
78
79 if ( $opt{help} ) {
80     require Pod::Usage;
81     Pod::Usage::pod2usage({ verbose => 2 });
82     exit;
83 }
84
85 require RT::Attributes;
86 my $attrs = RT::Attributes->new( RT->SystemUser );
87 $attrs->Limit( FIELD => 'Name', VALUE => 'Pref-RT::System-1' );
88 $attrs->Limit( FIELD => 'ObjectType', VALUE => 'RT::User' );
89
90 if ($opt{user}) {
91     my $user = RT::User->new( RT->SystemUser );
92     my ($val, $msg) = $user->Load($opt{user});
93     unless ($val) {
94         RT->Logger->error("Unable to load $opt{user}: $msg");
95         exit(1);
96     }
97     $attrs->Limit( FIELD => 'ObjectId', VALUE => $user->Id );
98 }
99
100 use Data::Dumper;
101 $Data::Dumper::Terse = 1;
102
103 while (my $attr = $attrs->Next ) {
104     my $user = RT::User->new( RT->SystemUser );
105     my ($val, $msg) = $user->Load($attr->ObjectId);
106     unless ($val) {
107         RT->Logger->warn("Unable to load User ".$attr->ObjectId." $msg");
108         next;
109     }
110     next if $user->Disabled;
111
112     my $content = $attr->Content;
113     if ( my $config_name = $opt{option} ) {
114         if ( exists $content->{$config_name} ) {
115             my $setting = $content->{$config_name};
116             print $user->Name, "\t$config_name: $setting\n";
117         }
118     } else {
119         print $user->Name, " => ", Dumper($content);
120     }
121
122 }
123
124 __END__
125
126 =head1 NAME
127
128 rt-preferences-viewer - show user defined preferences
129
130 =head1 SYNOPSIS
131
132     rt-preferences-viewer
133
134     rt-preferences-viewer --user=falcone
135         show only the falcone user's preferences
136
137     rt-preferences-viewer --option=EmailFrequency
138         show users who have set the EmailFrequence config option
139
140 =head1 DESCRIPTION
141
142 This script shows user settings of preferences.  If a user is using the system
143 default, it will not be listed.  You can limit to a user name or id or to users
144 with a particular option set.