1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
6 # <jesse@bestpractical.com>
8 # (Except where explicitly superseded by other copyright notices)
13 # This work is made available to you under the terms of Version 2 of
14 # the GNU General Public License. A copy of that license should have
15 # been provided with this software, but in any event can be snarfed
18 # This work is distributed in the hope that it will be useful, but
19 # WITHOUT ANY WARRANTY; without even the implied warranty of
20 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 # General Public License for more details.
23 # You should have received a copy of the GNU General Public License
24 # along with this program; if not, write to the Free Software
25 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 # 02110-1301 or visit their web page on the internet at
27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
30 # CONTRIBUTION SUBMISSION POLICY:
32 # (The following paragraph is not intended to limit the rights granted
33 # to you to modify and distribute this software under the terms of
34 # the GNU General Public License and is only of importance to you if
35 # you choose to contribute your changes and enhancements to the
36 # community by submitting them to Best Practical Solutions, LLC.)
38 # By intentionally submitting any modifications, corrections or
39 # derivatives to this work, or any other work intended for use with
40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
41 # you are the copyright holder for those contributions and you grant
42 # Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43 # royalty-free, perpetual, license to use, copy, create derivative
44 # works based on those contributions, and sublicense and distribute
45 # those contributions and any derivatives thereof.
47 # END BPS TAGGED BLOCK }}}
58 RT::Config - RT's config
64 my $config = new RT::Config;
68 my $rt_web_path = $config->Get('WebPath');
69 $config->Set(EmailOutputEncoding => 'latin1');
71 # get config object from RT package
74 my $config = RT->Config;
78 C<RT::Config> class provide access to RT's and RT extensions' config files.
80 RT uses two files for site configuring:
82 First file is F<RT_Config.pm> - core config file. This file is shipped
83 with RT distribution and contains default values for all available options.
84 B<You should never edit this file.>
86 Second file is F<RT_SiteConfig.pm> - site config file. You can use it
87 to customize your RT instance. In this file you can override any option
88 listed in core config file.
90 RT extensions could also provide thier config files. Extensions should
91 use F<< <NAME>_Config.pm >> and F<< <NAME>_SiteConfig.pm >> names for
92 config files, where <NAME> is extension name.
94 B<NOTE>: All options from RT's config and extensions' configs are saved
95 in one place and thus extension could override RT's options, but it is not
102 Hash of Config options that may be user overridable
103 or may require more logic than should live in RT_*Config.pm
105 Keyed by config name, there are several properties that
106 can be set for each config optin:
108 Section - What header this option should be grouped
109 under on the user Settings page
110 Overridable - Can users change this option
111 SortOrder - Within a Section, how should the options be sorted
112 for display to the user
113 Widget - Mason component path to widget that should be used
114 to display this config option
115 WidgetArguments - An argument hash passed to the WIdget
116 Description - Friendly description to show the user
117 Values - Arrayref of options (for select Widget)
118 ValuesLabel - Hashref, key is the Value from the Values
119 list, value is a user friendly description
121 Callback - subref that receives no arguments. It returns
122 a hashref of items that are added to the rest
123 of the WidgetArguments
124 PostLoadCheck - subref passed the RT::Config object and the current
125 setting of the config option. Can make further checks
126 (such as seeing if a library is installed) and then change
127 the setting of this or other options in the Config using
128 the RT::Config option.
133 # General user overridable options
135 Section => 'General',
138 Widget => '/Widgets/Form/Select',
140 Description => 'Default queue', #loc
142 my $ret = { Values => [], ValuesLabel => {}};
143 my $q = new RT::Queues($HTML::Mason::Commands::session{'CurrentUser'});
145 while (my $queue = $q->Next) {
146 next unless $queue->CurrentUserHasRight("CreateTicket");
147 push @{$ret->{Values}}, $queue->Id;
148 $ret->{ValuesLabel}{$queue->Id} = $queue->Name;
155 Section => 'General',
158 Widget => '/Widgets/Form/Select',
160 Description => 'Username format', # loc
161 Values => [qw(concise verbose)],
163 concise => 'Short usernames', # loc_left_pair
164 verbose => 'Name and email address', # loc_left_pair
168 WebDefaultStylesheet => {
169 Section => 'General', #loc
172 Widget => '/Widgets/Form/Select',
174 Description => 'Theme', #loc
175 # XXX: we need support for 'get values callback'
176 Values => [qw(3.5-default 3.4-compat web2 freeside2.1)],
179 MessageBoxRichText => {
180 Section => 'General',
183 Widget => '/Widgets/Form/Boolean',
185 Description => 'WYSIWYG message composer' # loc
188 MessageBoxRichTextHeight => {
189 Section => 'General',
192 Widget => '/Widgets/Form/Integer',
194 Description => 'WYSIWYG composer height', # loc
198 Section => 'General',
201 Widget => '/Widgets/Form/Integer',
203 Description => 'Message box width', #loc
206 MessageBoxHeight => {
207 Section => 'General',
210 Widget => '/Widgets/Form/Integer',
212 Description => 'Message box height', #loc
215 SearchResultsRefreshInterval => {
216 Section => 'General', #loc
219 Widget => '/Widgets/Form/Select',
221 Description => 'Search results refresh interval', #loc
222 Values => [qw(0 120 300 600 1200 3600 7200)],
224 0 => "Don't refresh search results.", #loc
225 120 => "Refresh search results every 2 minutes.", #loc
226 300 => "Refresh search results every 5 minutes.", #loc
227 600 => "Refresh search results every 10 minutes.", #loc
228 1200 => "Refresh search results every 20 minutes.", #loc
229 3600 => "Refresh search results every 60 minutes.", #loc
230 7200 => "Refresh search results every 120 minutes.", #loc
235 # User overridable options for RT at a glance
236 DefaultSummaryRows => {
237 Section => 'RT at a glance', #loc
240 Widget => '/Widgets/Form/Integer',
242 Description => 'Number of search results', #loc
245 HomePageRefreshInterval => {
246 Section => 'RT at a glance', #loc
249 Widget => '/Widgets/Form/Select',
251 Description => 'Home page refresh interval', #loc
252 Values => [qw(0 120 300 600 1200 3600 7200)],
254 0 => "Don't refresh home page.", #loc
255 120 => "Refresh home page every 2 minutes.", #loc
256 300 => "Refresh home page every 5 minutes.", #loc
257 600 => "Refresh home page every 10 minutes.", #loc
258 1200 => "Refresh home page every 20 minutes.", #loc
259 3600 => "Refresh home page every 60 minutes.", #loc
260 7200 => "Refresh home page every 120 minutes.", #loc
265 # User overridable options for Ticket displays
267 Section => 'Ticket display', #loc
270 Widget => '/Widgets/Form/Integer',
272 Description => 'Maximum inline message length', #loc
274 "Length in characters; Use '0' to show all messages inline, regardless of length" #loc
277 OldestTransactionsFirst => {
278 Section => 'Ticket display',
281 Widget => '/Widgets/Form/Boolean',
283 Description => 'Show oldest history first', #loc
286 ShowUnreadMessageNotifications => {
287 Section => 'Ticket display',
290 Widget => '/Widgets/Form/Boolean',
292 Description => 'Notify me of unread messages', #loc
297 Section => 'Ticket display',
300 Widget => '/Widgets/Form/Boolean',
302 Description => 'add <pre> tag around plain text attachments', #loc
303 Hints => "Use this to protect the format of plain text" #loc
307 Section => 'Ticket display',
310 Widget => '/Widgets/Form/Boolean',
312 Description => 'display wrapped and formatted plain text attachments', #loc
313 Hints => 'Use css rules to display text monospaced and with formatting preserved, but wrap as needed. This does not work well with IE6 and you should use the previous option', #loc
317 # User overridable locale options
319 Section => 'Locale', #loc
321 Widget => '/Widgets/Form/Select',
323 Description => 'Date format', #loc
324 Callback => sub { my $ret = { Values => [], ValuesLabel => {}};
325 my $date = new RT::Date($HTML::Mason::Commands::session{'CurrentUser'});
327 foreach my $value ($date->Formatters) {
328 push @{$ret->{Values}}, $value;
329 $ret->{ValuesLabel}{$value} = $date->$value();
338 PostLoadCheck => sub {
340 my $value = $self->Get('RTAddressRegexp');
343 #XXX freeside - should fix this at some point, but it is being WAY
344 #too noisy in the logs
346 # 'The RTAddressRegexp option is not set in the config.'
347 # .' Not setting this option results in additional SQL queries to'
348 # .' check whether each address belongs to RT or not.'
349 # .' It is especially important to set this option if RT recieves'
350 # .' emails on addresses that are not in the database or config.'
354 # User overridable mail options
356 Section => 'Mail', #loc
358 Default => 'Individual messages',
359 Widget => '/Widgets/Form/Select',
361 Description => 'Email delivery', #loc
363 'Individual messages', #loc
365 'Weekly digest', #loc
371 Section => 'Mail', #loc
374 Widget => '/Widgets/Form/Boolean',
376 Description => 'Outgoing mail', #loc
377 Hints => 'Should RT send you mail for ticket updates you make?', #loc
381 # this tends to break extensions that stash links in ticket update pages
384 PostLoadCheck => sub {
385 my ($self,$value) = @_;
386 $RT::Logger->error("your \$Organization setting ($value) appears to contain whitespace. Please fix this.")
391 # Internal config options
394 PostLoadCheck => sub {
398 return if $INC{'GraphViz.pm'};
400 return if eval {require GraphViz; 1};
401 $RT::Logger->debug("You've enabled GraphViz, but we couldn't load the module: $@");
402 $self->Set( DisableGraphViz => 1 );
407 PostLoadCheck => sub {
411 return if $INC{'GD.pm'};
413 return if eval {require GD; 1};
414 $RT::Logger->debug("You've enabled GD, but we couldn't load the module: $@");
415 $self->Set( DisableGD => 1 );
418 MailPlugins => { Type => 'ARRAY' },
419 Plugins => { Type => 'ARRAY' },
420 GnuPG => { Type => 'HASH' },
421 GnuPGOptions => { Type => 'HASH',
422 PostLoadCheck => sub {
424 my $gpg = $self->Get('GnuPG');
425 return unless $gpg->{'Enable'};
426 my $gpgopts = $self->Get('GnuPGOptions');
427 unless (-d $gpgopts->{homedir} && -r _ ) { # no homedir, no gpg
429 "RT's GnuPG libraries couldn't successfully read your".
430 " configured GnuPG home directory (".$gpgopts->{homedir}
431 ."). PGP support has been disabled");
432 $gpg->{'Enable'} = 0;
437 require RT::Crypt::GnuPG;
438 unless (RT::Crypt::GnuPG->Probe()) {
440 "RT's GnuPG libraries couldn't successfully execute gpg.".
441 " PGP support has been disabled");
442 $gpg->{'Enable'} = 0;
453 Object constructor returns new object. Takes no arguments.
459 my $class = ref($proto) ? ref($proto) : $proto;
460 my $self = bless {}, $class;
477 my %args = ( File => '', @_ );
478 $args{'File'} =~ s/(?<=Config)(?=\.pm$)/Meta/;
484 Load all configs. First of all load RT's config then load
485 extensions' config files in alphabetical order.
493 $self->InitConfig( File => 'RT_Config.pm' );
494 $self->LoadConfig( File => 'RT_Config.pm' );
496 my @configs = $self->Configs;
497 $self->InitConfig( File => $_ ) foreach @configs;
498 $self->LoadConfig( File => $_ ) foreach @configs;
504 Takes param hash with C<File> field.
505 First, the site configuration file is loaded, in order to establish
506 overall site settings like hostname and name of RT instance.
507 Then, the core configuration file is loaded to set fallback values
508 for all settings; it bases some values on settings from the site
511 B<Note> that core config file don't change options if site config
512 has set them so to add value to some option instead of
513 overriding you have to copy original value from core config file.
519 my %args = ( File => '', @_ );
520 $args{'File'} =~ s/(?<!Site)(?=Config\.pm$)/Site/;
521 if ( $args{'File'} eq 'RT_SiteConfig.pm'
522 and my $site_config = $ENV{RT_SITE_CONFIG} )
524 $self->_LoadConfig( %args, File => $site_config );
526 $self->_LoadConfig(%args);
528 $args{'File'} =~ s/Site(?=Config\.pm$)//;
529 $self->_LoadConfig(%args);
535 my %args = ( File => '', @_ );
537 my ($is_ext, $is_site);
538 if ( $args{'File'} eq ($ENV{RT_SITE_CONFIG}||'') ) {
539 ($is_ext, $is_site) = ('', 1);
541 $is_ext = $args{'File'} =~ /^(?!RT_)(?:(.*)_)(?:Site)?Config/ ? $1 : '';
542 $is_site = $args{'File'} =~ /SiteConfig/ ? 1 : 0;
547 local *Set = sub(\[$@%]@) {
548 my ( $opt_ref, @args ) = @_;
549 my ( $pack, $file, $line ) = caller;
550 return $self->SetFromConfig(
556 SiteConfig => $is_site,
557 Extension => $is_ext,
560 my @etc_dirs = ($RT::LocalEtcPath);
561 push @etc_dirs, RT->PluginDirs('etc') if $is_ext;
562 push @etc_dirs, $RT::EtcPath, @INC;
563 local @INC = @etc_dirs;
564 require $args{'File'};
567 return 1 if $is_site && $@ =~ qr{^Can't locate \Q$args{File}};
568 if ( $is_site || $@ !~ qr{^Can't locate \Q$args{File}} ) {
569 die qq{Couldn't load RT config file $args{'File'}:\n\n$@};
572 my $username = getpwuid($>);
573 my $group = getgrgid($();
575 my ( $file_path, $fileuid, $filegid );
576 foreach ( $RT::LocalEtcPath, $RT::EtcPath, @INC ) {
577 my $tmp = File::Spec->catfile( $_, $args{File} );
578 ( $fileuid, $filegid ) = ( stat($tmp) )[ 4, 5 ];
579 if ( defined $fileuid ) {
584 unless ($file_path) {
586 qq{Couldn't load RT config file $args{'File'} as user $username / group $group.\n}
587 . qq{The file couldn't be found in $RT::LocalEtcPath and $RT::EtcPath.\n$@};
592 RT couldn't load RT config file %s as:
596 The file is owned by user %s and group %s.
598 This usually means that the user/group your webserver is running
599 as cannot read the file. Be careful not to make the permissions
600 on this file too liberal, because it contains database passwords.
601 You may need to put the webserver user in the appropriate group
602 (%s) or change permissions be able to run succesfully.
605 my $fileusername = getpwuid($fileuid);
606 my $filegroup = getgrgid($filegid);
607 my $errormessage = sprintf( $message,
608 $file_path, $fileusername, $filegroup, $filegroup );
609 die "$errormessage\n$@";
616 foreach my $o ( grep $META{$_}{'PostLoadCheck'}, $self->Options( Overridable => undef ) ) {
617 $META{$o}->{'PostLoadCheck'}->( $self, $self->Get($o) );
623 Returns list of config files found in local etc, plugins' etc
624 and main etc directories.
632 foreach my $path ( $RT::LocalEtcPath, RT->PluginDirs('etc'), $RT::EtcPath ) {
633 my $mask = File::Spec->catfile( $path, "*_Config.pm" );
634 my @files = glob $mask;
635 @files = grep !/^RT_Config\.pm$/,
636 grep $_ && /^\w+_Config\.pm$/,
637 map { s/^.*[\\\/]//; $_ } @files;
638 push @configs, sort @files;
642 @configs = grep !$seen{$_}++, @configs;
648 Takes name of the option as argument and returns its current value.
650 In the case of a user-overridable option, first checks the user's
651 preferences before looking for site-wide configuration.
653 Returns values from RT_SiteConfig, RT_Config and then the %META hash
654 of configuration variables's "Default" for this config variable,
657 Returns different things in scalar and array contexts. For scalar
658 options it's not that important, however for arrays and hash it's.
659 In scalar context returns references to arrays and hashes.
661 Use C<scalar> perl's op to force context, especially when you use
662 C<(..., Argument => RT->Config->Get('ArrayOpt'), ...)>
663 as perl's '=>' op doesn't change context of the right hand argument to
664 scalar. Instead use C<(..., Argument => scalar RT->Config->Get('ArrayOpt'), ...)>.
666 It's also important for options that have no default value(no default
667 in F<etc/RT_Config.pm>). If you don't force scalar context then you'll
668 get empty list and all your named args will be messed up. For example
669 C<(arg1 => 1, arg2 => RT->Config->Get('OptionDoesNotExist'), arg3 => 3)>
670 will result in C<(arg1 => 1, arg2 => 'arg3', 3)> what is most probably
671 unexpected, or C<(arg1 => 1, arg2 => RT->Config->Get('ArrayOption'), arg3 => 3)>
672 will result in C<(arg1 => 1, arg2 => 'element of option', 'another_one' => ..., 'arg3', 3)>.
677 my ( $self, $name, $user ) = @_;
680 if ( $user && $user->id && $META{$name}->{'Overridable'} ) {
681 $user = $user->UserObj if $user->isa('RT::CurrentUser');
682 my $prefs = $user->Preferences($RT::System);
683 $res = $prefs->{$name} if $prefs;
685 $res = $OPTIONS{$name} unless defined $res;
686 $res = $META{$name}->{'Default'} unless defined $res;
687 return $self->_ReturnValue( $res, $META{$name}->{'Type'} || 'SCALAR' );
692 Set option's value to new value. Takes name of the option and new value.
695 The new value should be scalar, array or hash depending on type of the option.
696 If the option is not defined in meta or the default RT config then it is of
702 my ( $self, $name ) = ( shift, shift );
704 my $old = $OPTIONS{$name};
705 my $type = $META{$name}->{'Type'} || 'SCALAR';
706 if ( $type eq 'ARRAY' ) {
707 $OPTIONS{$name} = [@_];
708 { no warnings 'once'; no strict 'refs'; @{"RT::$name"} = (@_); }
709 } elsif ( $type eq 'HASH' ) {
710 $OPTIONS{$name} = {@_};
711 { no warnings 'once'; no strict 'refs'; %{"RT::$name"} = (@_); }
713 $OPTIONS{$name} = shift;
714 {no warnings 'once'; no strict 'refs'; ${"RT::$name"} = $OPTIONS{$name}; }
716 $META{$name}->{'Type'} = $type;
717 return $self->_ReturnValue( $old, $type );
721 my ( $self, $res, $type ) = @_;
722 return $res unless wantarray;
724 if ( $type eq 'ARRAY' ) {
725 return @{ $res || [] };
726 } elsif ( $type eq 'HASH' ) {
727 return %{ $res || {} };
745 unless ( $args{'File'} ) {
746 ( $args{'Package'}, $args{'File'}, $args{'Line'} ) = caller(1);
749 my $opt = $args{'Option'};
752 my $name = $self->__GetNameByRef($opt);
758 $type = $META{$name}->{'Type'} || 'SCALAR';
761 # if option is already set we have to check where
762 # it comes from and may be ignore it
763 if ( exists $OPTIONS{$name} ) {
764 if ( $args{'SiteConfig'} && $args{'Extension'} ) {
765 # if it's site config of an extension then it can only
766 # override options that came from its main config
767 if ( $args{'Extension'} ne $META{$name}->{'Source'}{'Extension'} ) {
768 my %source = %{ $META{$name}->{'Source'} };
770 "Change of config option '$name' at $args{'File'} line $args{'Line'} has been ignored."
771 ." This option earlier has been set in $source{'File'} line $source{'Line'}."
772 ." To overide this option use ". ($source{'Extension'}||'RT')
777 } elsif ( !$args{'SiteConfig'} && $META{$name}->{'Source'}{'SiteConfig'} ) {
778 # if it's core config then we can override any option that came from another
779 # core config, but not site config
781 my %source = %{ $META{$name}->{'Source'} };
782 if ( $source{'Extension'} ne $args{'Extension'} ) {
783 # as a site config is loaded earlier then its base config
784 # then we warn only on different extensions, for example
785 # RTIR's options is set in main site config or RTFM's
787 "Change of config option '$name' at $args{'File'} line $args{'Line'} has been ignored."
788 ." It's may be ok, but we want you to be aware."
789 ." This option earlier has been set in $source{'File'} line $source{'Line'}."
797 $META{$name}->{'Type'} = $type;
798 foreach (qw(Package File Line SiteConfig Extension)) {
799 $META{$name}->{'Source'}->{$_} = $args{$_};
801 $self->Set( $name, @{ $args{'Value'} } );
813 if ( !$pack && $last_pack ) {
814 my $tmp = $self->__GetNameByRef( $ref, $last_pack );
818 $pack .= '::' unless substr( $pack, -2 ) eq '::';
829 # scan $pack's nametable(hash)
830 foreach my $k ( keys %{$pack} ) {
832 # hash for main:: has reference on itself
833 next if $k eq 'main::';
835 # if entry has trailing '::' then
836 # it is link to other name space
838 $name = $self->__GetNameByRef( $ref, $k );
839 return $name if $name;
842 # entry of the table with references to
843 # SCALAR, ARRAY... and other types with
845 my $entry = ${$pack}{$k};
848 # get entry for type we are looking for
849 # XXX skip references to scalars or other references.
850 # Otherwie 5.10 goes boom. may be we should skip any
852 next if ref($entry) eq 'SCALAR' || ref($entry) eq 'REF';
853 my $entry_ref = *{$entry}{ ref($ref) };
854 next unless $entry_ref;
856 # if references are equal then we've found
857 if ( $entry_ref == $ref ) {
859 return ( $ref_sym{ ref($ref) } || '*' ) . $pack . $k;
874 return $META{ $_[1] };
882 map $_->{'Section'} || 'General',
888 my %args = ( Section => undef, Overridable => 1, Sorted => 1, @_ );
889 my @res = keys %META;
891 @res = grep( ( $META{$_}->{'Section'} || 'General' ) eq $args{'Section'},
893 ) if defined $args{'Section'};
895 if ( defined $args{'Overridable'} ) {
897 = grep( ( $META{$_}->{'Overridable'} || 0 ) == $args{'Overridable'},
901 if ( $args{'Sorted'} ) {
903 ($META{$a}->{SortOrder}||9999) <=> ($META{$b}->{SortOrder}||9999)
907 @res = sort { $a cmp $b } @res;
912 eval "require RT::Config_Vendor";
913 if ($@ && $@ !~ qr{^Can't locate RT/Config_Vendor.pm}) {
917 eval "require RT::Config_Local";
918 if ($@ && $@ !~ qr{^Can't locate RT/Config_Local.pm}) {