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
316 DisplayAfterQuickCreate => {
317 Section => 'Ticket display',
320 Widget => '/Widgets/Form/Boolean',
322 Description => 'On Quick Create, redirect to ticket display', #loc
327 # User overridable locale options
329 Section => 'Locale', #loc
331 Widget => '/Widgets/Form/Select',
333 Description => 'Date format', #loc
334 Callback => sub { my $ret = { Values => [], ValuesLabel => {}};
335 my $date = new RT::Date($HTML::Mason::Commands::session{'CurrentUser'});
337 foreach my $value ($date->Formatters) {
338 push @{$ret->{Values}}, $value;
339 $ret->{ValuesLabel}{$value} = $date->$value();
348 PostLoadCheck => sub {
350 my $value = $self->Get('RTAddressRegexp');
353 #XXX freeside - should fix this at some point, but it is being WAY
354 #too noisy in the logs
356 # 'The RTAddressRegexp option is not set in the config.'
357 # .' Not setting this option results in additional SQL queries to'
358 # .' check whether each address belongs to RT or not.'
359 # .' It is especially important to set this option if RT recieves'
360 # .' emails on addresses that are not in the database or config.'
364 # User overridable mail options
366 Section => 'Mail', #loc
368 Default => 'Individual messages',
369 Widget => '/Widgets/Form/Select',
371 Description => 'Email delivery', #loc
373 'Individual messages', #loc
375 'Weekly digest', #loc
381 Section => 'Mail', #loc
384 Widget => '/Widgets/Form/Boolean',
386 Description => 'Outgoing mail', #loc
387 Hints => 'Should RT send you mail for ticket updates you make?', #loc
391 # this tends to break extensions that stash links in ticket update pages
394 PostLoadCheck => sub {
395 my ($self,$value) = @_;
396 $RT::Logger->error("your \$Organization setting ($value) appears to contain whitespace. Please fix this.")
401 # Internal config options
404 PostLoadCheck => sub {
408 return if $INC{'GraphViz.pm'};
410 return if eval {require GraphViz; 1};
411 $RT::Logger->debug("You've enabled GraphViz, but we couldn't load the module: $@");
412 $self->Set( DisableGraphViz => 1 );
417 PostLoadCheck => sub {
421 return if $INC{'GD.pm'};
423 return if eval {require GD; 1};
424 $RT::Logger->debug("You've enabled GD, but we couldn't load the module: $@");
425 $self->Set( DisableGD => 1 );
428 MailPlugins => { Type => 'ARRAY' },
429 Plugins => { Type => 'ARRAY' },
430 GnuPG => { Type => 'HASH' },
431 GnuPGOptions => { Type => 'HASH',
432 PostLoadCheck => sub {
434 my $gpg = $self->Get('GnuPG');
435 return unless $gpg->{'Enable'};
436 my $gpgopts = $self->Get('GnuPGOptions');
437 unless (-d $gpgopts->{homedir} && -r _ ) { # no homedir, no gpg
439 "RT's GnuPG libraries couldn't successfully read your".
440 " configured GnuPG home directory (".$gpgopts->{homedir}
441 ."). PGP support has been disabled");
442 $gpg->{'Enable'} = 0;
447 require RT::Crypt::GnuPG;
448 unless (RT::Crypt::GnuPG->Probe()) {
450 "RT's GnuPG libraries couldn't successfully execute gpg.".
451 " PGP support has been disabled");
452 $gpg->{'Enable'} = 0;
463 Object constructor returns new object. Takes no arguments.
469 my $class = ref($proto) ? ref($proto) : $proto;
470 my $self = bless {}, $class;
487 my %args = ( File => '', @_ );
488 $args{'File'} =~ s/(?<=Config)(?=\.pm$)/Meta/;
494 Load all configs. First of all load RT's config then load
495 extensions' config files in alphabetical order.
503 $self->InitConfig( File => 'RT_Config.pm' );
504 $self->LoadConfig( File => 'RT_Config.pm' );
506 my @configs = $self->Configs;
507 $self->InitConfig( File => $_ ) foreach @configs;
508 $self->LoadConfig( File => $_ ) foreach @configs;
514 Takes param hash with C<File> field.
515 First, the site configuration file is loaded, in order to establish
516 overall site settings like hostname and name of RT instance.
517 Then, the core configuration file is loaded to set fallback values
518 for all settings; it bases some values on settings from the site
521 B<Note> that core config file don't change options if site config
522 has set them so to add value to some option instead of
523 overriding you have to copy original value from core config file.
529 my %args = ( File => '', @_ );
530 $args{'File'} =~ s/(?<!Site)(?=Config\.pm$)/Site/;
531 if ( $args{'File'} eq 'RT_SiteConfig.pm'
532 and my $site_config = $ENV{RT_SITE_CONFIG} )
534 $self->_LoadConfig( %args, File => $site_config );
536 $self->_LoadConfig(%args);
538 $args{'File'} =~ s/Site(?=Config\.pm$)//;
539 $self->_LoadConfig(%args);
545 my %args = ( File => '', @_ );
547 my ($is_ext, $is_site);
548 if ( $args{'File'} eq ($ENV{RT_SITE_CONFIG}||'') ) {
549 ($is_ext, $is_site) = ('', 1);
551 $is_ext = $args{'File'} =~ /^(?!RT_)(?:(.*)_)(?:Site)?Config/ ? $1 : '';
552 $is_site = $args{'File'} =~ /SiteConfig/ ? 1 : 0;
557 local *Set = sub(\[$@%]@) {
558 my ( $opt_ref, @args ) = @_;
559 my ( $pack, $file, $line ) = caller;
560 return $self->SetFromConfig(
566 SiteConfig => $is_site,
567 Extension => $is_ext,
570 my @etc_dirs = ($RT::LocalEtcPath);
571 push @etc_dirs, RT->PluginDirs('etc') if $is_ext;
572 push @etc_dirs, $RT::EtcPath, @INC;
573 local @INC = @etc_dirs;
574 require $args{'File'};
577 return 1 if $is_site && $@ =~ qr{^Can't locate \Q$args{File}};
578 if ( $is_site || $@ !~ qr{^Can't locate \Q$args{File}} ) {
579 die qq{Couldn't load RT config file $args{'File'}:\n\n$@};
582 my $username = getpwuid($>);
583 my $group = getgrgid($();
585 my ( $file_path, $fileuid, $filegid );
586 foreach ( $RT::LocalEtcPath, $RT::EtcPath, @INC ) {
587 my $tmp = File::Spec->catfile( $_, $args{File} );
588 ( $fileuid, $filegid ) = ( stat($tmp) )[ 4, 5 ];
589 if ( defined $fileuid ) {
594 unless ($file_path) {
596 qq{Couldn't load RT config file $args{'File'} as user $username / group $group.\n}
597 . qq{The file couldn't be found in $RT::LocalEtcPath and $RT::EtcPath.\n$@};
602 RT couldn't load RT config file %s as:
606 The file is owned by user %s and group %s.
608 This usually means that the user/group your webserver is running
609 as cannot read the file. Be careful not to make the permissions
610 on this file too liberal, because it contains database passwords.
611 You may need to put the webserver user in the appropriate group
612 (%s) or change permissions be able to run succesfully.
615 my $fileusername = getpwuid($fileuid);
616 my $filegroup = getgrgid($filegid);
617 my $errormessage = sprintf( $message,
618 $file_path, $fileusername, $filegroup, $filegroup );
619 die "$errormessage\n$@";
626 foreach my $o ( grep $META{$_}{'PostLoadCheck'}, $self->Options( Overridable => undef ) ) {
627 $META{$o}->{'PostLoadCheck'}->( $self, $self->Get($o) );
633 Returns list of config files found in local etc, plugins' etc
634 and main etc directories.
642 foreach my $path ( $RT::LocalEtcPath, RT->PluginDirs('etc'), $RT::EtcPath ) {
643 my $mask = File::Spec->catfile( $path, "*_Config.pm" );
644 my @files = glob $mask;
645 @files = grep !/^RT_Config\.pm$/,
646 grep $_ && /^\w+_Config\.pm$/,
647 map { s/^.*[\\\/]//; $_ } @files;
648 push @configs, sort @files;
652 @configs = grep !$seen{$_}++, @configs;
658 Takes name of the option as argument and returns its current value.
660 In the case of a user-overridable option, first checks the user's
661 preferences before looking for site-wide configuration.
663 Returns values from RT_SiteConfig, RT_Config and then the %META hash
664 of configuration variables's "Default" for this config variable,
667 Returns different things in scalar and array contexts. For scalar
668 options it's not that important, however for arrays and hash it's.
669 In scalar context returns references to arrays and hashes.
671 Use C<scalar> perl's op to force context, especially when you use
672 C<(..., Argument => RT->Config->Get('ArrayOpt'), ...)>
673 as perl's '=>' op doesn't change context of the right hand argument to
674 scalar. Instead use C<(..., Argument => scalar RT->Config->Get('ArrayOpt'), ...)>.
676 It's also important for options that have no default value(no default
677 in F<etc/RT_Config.pm>). If you don't force scalar context then you'll
678 get empty list and all your named args will be messed up. For example
679 C<(arg1 => 1, arg2 => RT->Config->Get('OptionDoesNotExist'), arg3 => 3)>
680 will result in C<(arg1 => 1, arg2 => 'arg3', 3)> what is most probably
681 unexpected, or C<(arg1 => 1, arg2 => RT->Config->Get('ArrayOption'), arg3 => 3)>
682 will result in C<(arg1 => 1, arg2 => 'element of option', 'another_one' => ..., 'arg3', 3)>.
687 my ( $self, $name, $user ) = @_;
690 if ( $user && $user->id && $META{$name}->{'Overridable'} ) {
691 $user = $user->UserObj if $user->isa('RT::CurrentUser');
692 my $prefs = $user->Preferences($RT::System);
693 $res = $prefs->{$name} if $prefs;
695 $res = $OPTIONS{$name} unless defined $res;
696 $res = $META{$name}->{'Default'} unless defined $res;
697 return $self->_ReturnValue( $res, $META{$name}->{'Type'} || 'SCALAR' );
702 Set option's value to new value. Takes name of the option and new value.
705 The new value should be scalar, array or hash depending on type of the option.
706 If the option is not defined in meta or the default RT config then it is of
712 my ( $self, $name ) = ( shift, shift );
714 my $old = $OPTIONS{$name};
715 my $type = $META{$name}->{'Type'} || 'SCALAR';
716 if ( $type eq 'ARRAY' ) {
717 $OPTIONS{$name} = [@_];
718 { no warnings 'once'; no strict 'refs'; @{"RT::$name"} = (@_); }
719 } elsif ( $type eq 'HASH' ) {
720 $OPTIONS{$name} = {@_};
721 { no warnings 'once'; no strict 'refs'; %{"RT::$name"} = (@_); }
723 $OPTIONS{$name} = shift;
724 {no warnings 'once'; no strict 'refs'; ${"RT::$name"} = $OPTIONS{$name}; }
726 $META{$name}->{'Type'} = $type;
727 return $self->_ReturnValue( $old, $type );
731 my ( $self, $res, $type ) = @_;
732 return $res unless wantarray;
734 if ( $type eq 'ARRAY' ) {
735 return @{ $res || [] };
736 } elsif ( $type eq 'HASH' ) {
737 return %{ $res || {} };
755 unless ( $args{'File'} ) {
756 ( $args{'Package'}, $args{'File'}, $args{'Line'} ) = caller(1);
759 my $opt = $args{'Option'};
762 my $name = $self->__GetNameByRef($opt);
768 $type = $META{$name}->{'Type'} || 'SCALAR';
771 # if option is already set we have to check where
772 # it comes from and may be ignore it
773 if ( exists $OPTIONS{$name} ) {
774 if ( $args{'SiteConfig'} && $args{'Extension'} ) {
775 # if it's site config of an extension then it can only
776 # override options that came from its main config
777 if ( $args{'Extension'} ne $META{$name}->{'Source'}{'Extension'} ) {
778 my %source = %{ $META{$name}->{'Source'} };
780 "Change of config option '$name' at $args{'File'} line $args{'Line'} has been ignored."
781 ." This option earlier has been set in $source{'File'} line $source{'Line'}."
782 ." To overide this option use ". ($source{'Extension'}||'RT')
787 } elsif ( !$args{'SiteConfig'} && $META{$name}->{'Source'}{'SiteConfig'} ) {
788 # if it's core config then we can override any option that came from another
789 # core config, but not site config
791 my %source = %{ $META{$name}->{'Source'} };
792 if ( $source{'Extension'} ne $args{'Extension'} ) {
793 # as a site config is loaded earlier then its base config
794 # then we warn only on different extensions, for example
795 # RTIR's options is set in main site config or RTFM's
797 "Change of config option '$name' at $args{'File'} line $args{'Line'} has been ignored."
798 ." It's may be ok, but we want you to be aware."
799 ." This option earlier has been set in $source{'File'} line $source{'Line'}."
807 $META{$name}->{'Type'} = $type;
808 foreach (qw(Package File Line SiteConfig Extension)) {
809 $META{$name}->{'Source'}->{$_} = $args{$_};
811 $self->Set( $name, @{ $args{'Value'} } );
823 if ( !$pack && $last_pack ) {
824 my $tmp = $self->__GetNameByRef( $ref, $last_pack );
828 $pack .= '::' unless substr( $pack, -2 ) eq '::';
839 # scan $pack's nametable(hash)
840 foreach my $k ( keys %{$pack} ) {
842 # hash for main:: has reference on itself
843 next if $k eq 'main::';
845 # if entry has trailing '::' then
846 # it is link to other name space
848 $name = $self->__GetNameByRef( $ref, $k );
849 return $name if $name;
852 # entry of the table with references to
853 # SCALAR, ARRAY... and other types with
855 my $entry = ${$pack}{$k};
858 # get entry for type we are looking for
859 # XXX skip references to scalars or other references.
860 # Otherwie 5.10 goes boom. may be we should skip any
862 next if ref($entry) eq 'SCALAR' || ref($entry) eq 'REF';
863 my $entry_ref = *{$entry}{ ref($ref) };
864 next unless $entry_ref;
866 # if references are equal then we've found
867 if ( $entry_ref == $ref ) {
869 return ( $ref_sym{ ref($ref) } || '*' ) . $pack . $k;
884 return $META{ $_[1] };
892 map $_->{'Section'} || 'General',
898 my %args = ( Section => undef, Overridable => 1, Sorted => 1, @_ );
899 my @res = keys %META;
901 @res = grep( ( $META{$_}->{'Section'} || 'General' ) eq $args{'Section'},
903 ) if defined $args{'Section'};
905 if ( defined $args{'Overridable'} ) {
907 = grep( ( $META{$_}->{'Overridable'} || 0 ) == $args{'Overridable'},
911 if ( $args{'Sorted'} ) {
913 ($META{$a}->{SortOrder}||9999) <=> ($META{$b}->{SortOrder}||9999)
917 @res = sort { $a cmp $b } @res;
922 eval "require RT::Config_Vendor";
923 if ($@ && $@ !~ qr{^Can't locate RT/Config_Vendor.pm}) {
927 eval "require RT::Config_Local";
928 if ($@ && $@ !~ qr{^Can't locate RT/Config_Local.pm}) {