1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
6 # <sales@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 }}}
59 RT::Config - RT's config
65 my $config = RT::Config->new;
69 my $rt_web_path = $config->Get('WebPath');
70 $config->Set(EmailOutputEncoding => 'latin1');
72 # get config object from RT package
75 my $config = RT->Config;
79 C<RT::Config> class provide access to RT's and RT extensions' config files.
81 RT uses two files for site configuring:
83 First file is F<RT_Config.pm> - core config file. This file is shipped
84 with RT distribution and contains default values for all available options.
85 B<You should never edit this file.>
87 Second file is F<RT_SiteConfig.pm> - site config file. You can use it
88 to customize your RT instance. In this file you can override any option
89 listed in core config file.
91 RT extensions could also provide thier config files. Extensions should
92 use F<< <NAME>_Config.pm >> and F<< <NAME>_SiteConfig.pm >> names for
93 config files, where <NAME> is extension name.
95 B<NOTE>: All options from RT's config and extensions' configs are saved
96 in one place and thus extension could override RT's options, but it is not
103 Hash of Config options that may be user overridable
104 or may require more logic than should live in RT_*Config.pm
106 Keyed by config name, there are several properties that
107 can be set for each config optin:
109 Section - What header this option should be grouped
110 under on the user Settings page
111 Overridable - Can users change this option
112 SortOrder - Within a Section, how should the options be sorted
113 for display to the user
114 Widget - Mason component path to widget that should be used
115 to display this config option
116 WidgetArguments - An argument hash passed to the WIdget
117 Description - Friendly description to show the user
118 Values - Arrayref of options (for select Widget)
119 ValuesLabel - Hashref, key is the Value from the Values
120 list, value is a user friendly description
122 Callback - subref that receives no arguments. It returns
123 a hashref of items that are added to the rest
124 of the WidgetArguments
125 PostLoadCheck - subref passed the RT::Config object and the current
126 setting of the config option. Can make further checks
127 (such as seeing if a library is installed) and then change
128 the setting of this or other options in the Config using
129 the RT::Config option.
130 Obfuscate - subref passed the RT::Config object, current setting of the config option
131 and a user object, can return obfuscated value. it's called in
132 RT->Config->GetObfuscated()
137 # General user overridable options
139 Section => 'General',
142 Widget => '/Widgets/Form/Select',
144 Description => 'Default queue', #loc
146 my $ret = { Values => [], ValuesLabel => {}};
147 my $q = RT::Queues->new($HTML::Mason::Commands::session{'CurrentUser'});
149 while (my $queue = $q->Next) {
150 next unless $queue->CurrentUserHasRight("CreateTicket");
151 push @{$ret->{Values}}, $queue->Id;
152 $ret->{ValuesLabel}{$queue->Id} = $queue->Name;
158 RememberDefaultQueue => {
159 Section => 'General',
162 Widget => '/Widgets/Form/Boolean',
164 Description => 'Remember default queue' # loc
168 Section => 'General',
171 Widget => '/Widgets/Form/Select',
173 Description => 'Username format', # loc
174 Values => [qw(concise verbose)],
176 concise => 'Short usernames', # loc
177 verbose => 'Name and email address', # loc
181 AutocompleteOwners => {
182 Section => 'General',
185 Widget => '/Widgets/Form/Boolean',
187 Description => 'Use autocomplete to find owners?', # loc
188 Hints => 'Replaces the owner dropdowns with textboxes' #loc
191 WebDefaultStylesheet => {
192 Section => 'General', #loc
195 Widget => '/Widgets/Form/Select',
197 Description => 'Theme', #loc
198 # XXX: we need support for 'get values callback'
199 Values => [qw(web2 aileron ballard)],
201 PostLoadCheck => sub {
203 my $value = $self->Get('WebDefaultStylesheet');
205 my @comp_roots = RT::Interface::Web->ComponentRoots;
206 for my $comp_root (@comp_roots) {
207 return if -d $comp_root.'/NoAuth/css/'.$value;
210 $RT::Logger->warning(
211 "The default stylesheet ($value) does not exist in this instance of RT. "
212 . "Defaulting to aileron."
215 $self->Set('WebDefaultStylesheet', 'aileron');
218 UseSideBySideLayout => {
219 Section => 'Ticket composition',
222 Widget => '/Widgets/Form/Boolean',
224 Description => 'Use a two column layout for create and update forms?' # loc
227 MessageBoxRichText => {
228 Section => 'Ticket composition',
231 Widget => '/Widgets/Form/Boolean',
233 Description => 'WYSIWYG message composer' # loc
236 MessageBoxRichTextHeight => {
237 Section => 'Ticket composition',
240 Widget => '/Widgets/Form/Integer',
242 Description => 'WYSIWYG composer height', # loc
246 Section => 'Ticket composition',
249 Widget => '/Widgets/Form/Integer',
251 Description => 'Message box width', #loc
254 MessageBoxHeight => {
255 Section => 'Ticket composition',
258 Widget => '/Widgets/Form/Integer',
260 Description => 'Message box height', #loc
264 Section => 'Ticket composition', #loc
267 Widget => '/Widgets/Form/Select',
269 Description => 'Message box wrapping', #loc
270 Values => [qw(SOFT HARD)],
271 Hints => "When the WYSIWYG editor is not enabled, this setting determines whether automatic line wraps in the ticket message box are sent to RT or not.", # loc
274 DefaultTimeUnitsToHours => {
275 Section => 'Ticket composition', #loc
278 Widget => '/Widgets/Form/Boolean',
280 Description => 'Enter time in hours by default', #loc
281 Hints => 'Only for entry, not display', #loc
284 SearchResultsRefreshInterval => {
285 Section => 'General', #loc
288 Widget => '/Widgets/Form/Select',
290 Description => 'Search results refresh interval', #loc
291 Values => [qw(0 120 300 600 1200 3600 7200)],
293 0 => "Don't refresh search results.", #loc
294 120 => "Refresh search results every 2 minutes.", #loc
295 300 => "Refresh search results every 5 minutes.", #loc
296 600 => "Refresh search results every 10 minutes.", #loc
297 1200 => "Refresh search results every 20 minutes.", #loc
298 3600 => "Refresh search results every 60 minutes.", #loc
299 7200 => "Refresh search results every 120 minutes.", #loc
304 # User overridable options for RT at a glance
305 DefaultSummaryRows => {
306 Section => 'RT at a glance', #loc
309 Widget => '/Widgets/Form/Integer',
311 Description => 'Number of search results', #loc
314 HomePageRefreshInterval => {
315 Section => 'RT at a glance', #loc
318 Widget => '/Widgets/Form/Select',
320 Description => 'Home page refresh interval', #loc
321 Values => [qw(0 120 300 600 1200 3600 7200)],
323 0 => "Don't refresh home page.", #loc
324 120 => "Refresh home page every 2 minutes.", #loc
325 300 => "Refresh home page every 5 minutes.", #loc
326 600 => "Refresh home page every 10 minutes.", #loc
327 1200 => "Refresh home page every 20 minutes.", #loc
328 3600 => "Refresh home page every 60 minutes.", #loc
329 7200 => "Refresh home page every 120 minutes.", #loc
334 # User overridable options for Ticket displays
336 Section => 'Ticket display', #loc
339 Widget => '/Widgets/Form/Integer',
341 Description => 'Maximum inline message length', #loc
343 "Length in characters; Use '0' to show all messages inline, regardless of length" #loc
346 OldestTransactionsFirst => {
347 Section => 'Ticket display',
350 Widget => '/Widgets/Form/Boolean',
352 Description => 'Show oldest history first', #loc
355 DeferTransactionLoading => {
356 Section => 'Ticket display',
359 Widget => '/Widgets/Form/Boolean',
361 Description => 'Hide ticket history by default', #loc
364 ShowUnreadMessageNotifications => {
365 Section => 'Ticket display',
368 Widget => '/Widgets/Form/Boolean',
370 Description => 'Notify me of unread messages', #loc
375 Section => 'Ticket display',
378 Widget => '/Widgets/Form/Boolean',
380 Description => 'add <pre> tag around plain text attachments', #loc
381 Hints => "Use this to protect the format of plain text" #loc
385 Section => 'Ticket display',
388 Widget => '/Widgets/Form/Boolean',
390 Description => 'display wrapped and formatted plain text attachments', #loc
391 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
394 MoreAboutRequestorTicketList => {
395 Section => 'Ticket display', #loc
398 Widget => '/Widgets/Form/Select',
400 Description => q|What tickets to display in the 'More about requestor' box|, #loc
401 Values => [qw(Active Inactive All None)],
403 Active => "Show the Requestor's 10 highest priority active tickets", #loc
404 Inactive => "Show the Requestor's 10 highest priority inactive tickets", #loc
405 All => "Show the Requestor's 10 highest priority tickets", #loc
406 None => "Show no tickets for the Requestor", #loc
410 SimplifiedRecipients => {
411 Section => 'Ticket display', #loc
414 Widget => '/Widgets/Form/Boolean',
416 Description => q|Show simplified recipient list on ticket update|, #loc
419 DisplayTicketAfterQuickCreate => {
420 Section => 'Ticket display',
423 Widget => '/Widgets/Form/Boolean',
425 Description => q{Display ticket after "Quick Create"}, #loc
429 # User overridable locale options
431 Section => 'Locale', #loc
433 Widget => '/Widgets/Form/Select',
435 Description => 'Date format', #loc
436 Callback => sub { my $ret = { Values => [], ValuesLabel => {}};
437 my $date = RT::Date->new($HTML::Mason::Commands::session{'CurrentUser'});
439 foreach my $value ($date->Formatters) {
440 push @{$ret->{Values}}, $value;
441 $ret->{ValuesLabel}{$value} = $date->Get(
453 PostLoadCheck => sub {
455 my $value = $self->Get('RTAddressRegexp');
458 'The RTAddressRegexp option is not set in the config.'
459 .' Not setting this option results in additional SQL queries to'
460 .' check whether each address belongs to RT or not.'
461 .' It is especially important to set this option if RT recieves'
462 .' emails on addresses that are not in the database or config.'
464 } elsif (ref $value and ref $value eq "Regexp") {
465 # Ensure that the regex is case-insensitive; while the
466 # local part of email addresses is _technically_
467 # case-sensitive, most MTAs don't treat it as such.
468 $RT::Logger->warning(
469 'RTAddressRegexp is set to a case-sensitive regular expression.'
470 .' This may lead to mail loops with MTAs which treat the'
471 .' local part as case-insensitive -- which is most of them.'
472 ) if "$value" =~ /^\(\?[a-z]*-([a-z]*):/ and "$1" =~ /i/;
476 # User overridable mail options
478 Section => 'Mail', #loc
480 Default => 'Individual messages',
481 Widget => '/Widgets/Form/Select',
483 Description => 'Email delivery', #loc
485 'Individual messages', #loc
487 'Weekly digest', #loc
493 Section => 'Mail', #loc
496 Widget => '/Widgets/Form/Boolean',
498 Description => 'Outgoing mail', #loc
499 Hints => 'Should RT send you mail for ticket updates you make?', #loc
503 # this tends to break extensions that stash links in ticket update pages
506 PostLoadCheck => sub {
507 my ($self,$value) = @_;
508 $RT::Logger->error("your \$Organization setting ($value) appears to contain whitespace. Please fix this.")
513 # Internal config options
516 PostLoadCheck => sub {
518 my $v = $self->Get('FullTextSearch');
519 return unless $v->{Enable} and $v->{Indexed};
520 my $dbtype = $self->Get('DatabaseType');
521 if ($dbtype eq 'Oracle') {
522 if (not $v->{IndexName}) {
523 $RT::Logger->error("No IndexName set for full-text index; disabling");
524 $v->{Enable} = $v->{Indexed} = 0;
526 } elsif ($dbtype eq 'Pg') {
528 if (not $v->{'Column'}) {
529 $RT::Logger->error("No Column set for full-text index; disabling");
530 $v->{Enable} = $v->{Indexed} = 0;
531 } elsif ($v->{'Column'} eq "Content"
532 and (not $v->{'Table'} or $v->{'Table'} eq "Attachments")) {
533 $RT::Logger->error("Column for full-text index is set to Content, not tsvector column; disabling");
534 $v->{Enable} = $v->{Indexed} = 0;
536 } elsif ($dbtype eq 'mysql') {
537 if (not $v->{'Table'}) {
538 $RT::Logger->error("No Table set for full-text index; disabling");
539 $v->{Enable} = $v->{Indexed} = 0;
540 } elsif ($v->{'Table'} eq "Attachments") {
541 $RT::Logger->error("Table for full-text index is set to Attachments, not SphinxSE table; disabling");
542 $v->{Enable} = $v->{Indexed} = 0;
543 } elsif (not $v->{'MaxMatches'}) {
544 $RT::Logger->warn("No MaxMatches set for full-text index; defaulting to 10000");
545 $v->{MaxMatches} = 10_000;
548 $RT::Logger->error("Indexed full-text-search not supported for $dbtype");
555 PostLoadCheck => sub {
559 return if $INC{'GraphViz.pm'};
561 return if eval {require GraphViz; 1};
562 $RT::Logger->debug("You've enabled GraphViz, but we couldn't load the module: $@");
563 $self->Set( DisableGraphViz => 1 );
568 PostLoadCheck => sub {
572 return if $INC{'GD.pm'};
574 return if eval {require GD; 1};
575 $RT::Logger->debug("You've enabled GD, but we couldn't load the module: $@");
576 $self->Set( DisableGD => 1 );
579 MailPlugins => { Type => 'ARRAY' },
582 PostLoadCheck => sub {
584 my $value = $self->Get('Plugins');
585 # XXX Remove in RT 4.2
586 return unless $value and grep {$_ eq "RT::FM"} @{$value};
587 warn 'RTFM has been integrated into core RT, and must be removed from your @Plugins';
590 GnuPG => { Type => 'HASH' },
591 GnuPGOptions => { Type => 'HASH',
592 PostLoadCheck => sub {
594 my $gpg = $self->Get('GnuPG');
595 return unless $gpg->{'Enable'};
596 my $gpgopts = $self->Get('GnuPGOptions');
597 unless (-d $gpgopts->{homedir} && -r _ ) { # no homedir, no gpg
599 "RT's GnuPG libraries couldn't successfully read your".
600 " configured GnuPG home directory (".$gpgopts->{homedir}
601 ."). PGP support has been disabled");
602 $gpg->{'Enable'} = 0;
607 require RT::Crypt::GnuPG;
608 unless (RT::Crypt::GnuPG->Probe()) {
610 "RT's GnuPG libraries couldn't successfully execute gpg.".
611 " PGP support has been disabled");
612 $gpg->{'Enable'} = 0;
616 ReferrerWhitelist => { Type => 'ARRAY' },
617 ResolveDefaultUpdateType => {
618 PostLoadCheck => sub {
621 return unless $value;
622 $RT::Logger->info('The ResolveDefaultUpdateType config option has been deprecated. '.
623 'You can change the site default in your %Lifecycles config.');
627 PostLoadCheck => sub {
631 # "In most cases, you should leave $WebPath set to '' (an empty value)."
632 return unless $value;
634 # try to catch someone who assumes that you shouldn't leave this empty
636 $RT::Logger->error("For the WebPath config option, use the empty string instead of /");
640 # $WebPath requires a leading / but no trailing /, or it can be blank.
641 return if $value =~ m{^/.+[^/]$};
643 if ($value =~ m{/$}) {
644 $RT::Logger->error("The WebPath config option requires no trailing slash");
647 if ($value !~ m{^/}) {
648 $RT::Logger->error("The WebPath config option requires a leading slash");
653 PostLoadCheck => sub {
658 $RT::Logger->error("You must set the WebDomain config option");
662 if ($value =~ m{^(\w+://)}) {
663 $RT::Logger->error("The WebDomain config option must not contain a scheme ($1)");
667 if ($value =~ m{(/.*)}) {
668 $RT::Logger->error("The WebDomain config option must not contain a path ($1)");
672 if ($value =~ m{:(\d*)}) {
673 $RT::Logger->error("The WebDomain config option must not contain a port ($1)");
679 PostLoadCheck => sub {
684 $RT::Logger->error("You must set the WebPort config option");
688 if ($value !~ m{^\d+$}) {
689 $RT::Logger->error("The WebPort config option must be an integer");
694 PostLoadCheck => sub {
699 $RT::Logger->error("You must set the WebBaseURL config option");
703 if ($value !~ m{^https?://}i) {
704 $RT::Logger->error("The WebBaseURL config option must contain a scheme (http or https)");
707 if ($value =~ m{/$}) {
708 $RT::Logger->error("The WebBaseURL config option requires no trailing slash");
711 if ($value =~ m{^https?://.+?(/[^/].*)}i) {
712 $RT::Logger->error("The WebBaseURL config option must not contain a path ($1)");
717 PostLoadCheck => sub {
722 $RT::Logger->error("You must set the WebURL config option");
726 if ($value !~ m{^https?://}i) {
727 $RT::Logger->error("The WebURL config option must contain a scheme (http or https)");
730 if ($value !~ m{/$}) {
731 $RT::Logger->error("The WebURL config option requires a trailing slash");
735 EmailInputEncodings => {
737 PostLoadCheck => sub {
739 my $value = $self->Get('EmailInputEncodings');
740 return unless $value && @$value;
743 foreach my $encoding ( grep defined && length, splice @$value ) {
744 next if $seen{ $encoding };
745 if ( $encoding eq '*' ) {
746 unshift @$value, '*';
750 my $canonic = Encode::resolve_alias( $encoding );
751 unless ( $canonic ) {
752 warn "Unknown encoding '$encoding' in \@EmailInputEncodings option";
754 elsif ( $seen{ $canonic }++ ) {
758 push @$value, $canonic;
766 PostLoadCheck => sub {
769 # XXX Remove in RT 4.2
771 The ActiveStatus configuration has been replaced by the new Lifecycles
772 functionality. You should set the 'active' property of the 'default'
773 lifecycle and add transition rules; see RT_Config.pm for documentation.
779 PostLoadCheck => sub {
782 # XXX Remove in RT 4.2
784 The InactiveStatus configuration has been replaced by the new Lifecycles
785 functionality. You should set the 'inactive' property of the 'default'
786 lifecycle and add transition rules; see RT_Config.pm for documentation.
797 Object constructor returns new object. Takes no arguments.
803 my $class = ref($proto) ? ref($proto) : $proto;
804 my $self = bless {}, $class;
821 my %args = ( File => '', @_ );
822 $args{'File'} =~ s/(?<=Config)(?=\.pm$)/Meta/;
828 Load all configs. First of all load RT's config then load
829 extensions' config files in alphabetical order.
837 $self->InitConfig( File => 'RT_Config.pm' );
838 $self->LoadConfig( File => 'RT_Config.pm' );
840 my @configs = $self->Configs;
841 $self->InitConfig( File => $_ ) foreach @configs;
842 $self->LoadConfig( File => $_ ) foreach @configs;
848 Takes param hash with C<File> field.
849 First, the site configuration file is loaded, in order to establish
850 overall site settings like hostname and name of RT instance.
851 Then, the core configuration file is loaded to set fallback values
852 for all settings; it bases some values on settings from the site
855 B<Note> that core config file don't change options if site config
856 has set them so to add value to some option instead of
857 overriding you have to copy original value from core config file.
863 my %args = ( File => '', @_ );
864 $args{'File'} =~ s/(?<!Site)(?=Config\.pm$)/Site/;
865 if ( $args{'File'} eq 'RT_SiteConfig.pm'
866 and my $site_config = $ENV{RT_SITE_CONFIG} )
868 $self->_LoadConfig( %args, File => $site_config );
870 $self->_LoadConfig(%args);
872 $args{'File'} =~ s/Site(?=Config\.pm$)//;
873 $self->_LoadConfig(%args);
879 my %args = ( File => '', @_ );
881 my ($is_ext, $is_site);
882 if ( $args{'File'} eq ($ENV{RT_SITE_CONFIG}||'') ) {
883 ($is_ext, $is_site) = ('', 1);
885 $is_ext = $args{'File'} =~ /^(?!RT_)(?:(.*)_)(?:Site)?Config/ ? $1 : '';
886 $is_site = $args{'File'} =~ /SiteConfig/ ? 1 : 0;
891 local *Set = sub(\[$@%]@) {
892 my ( $opt_ref, @args ) = @_;
893 my ( $pack, $file, $line ) = caller;
894 return $self->SetFromConfig(
900 SiteConfig => $is_site,
901 Extension => $is_ext,
904 my @etc_dirs = ($RT::LocalEtcPath);
905 push @etc_dirs, RT->PluginDirs('etc') if $is_ext;
906 push @etc_dirs, $RT::EtcPath, @INC;
907 local @INC = @etc_dirs;
908 require $args{'File'};
911 return 1 if $is_site && $@ =~ /^Can't locate \Q$args{File}/;
912 if ( $is_site || $@ !~ /^Can't locate \Q$args{File}/ ) {
913 die qq{Couldn't load RT config file $args{'File'}:\n\n$@};
916 my $username = getpwuid($>);
917 my $group = getgrgid($();
919 my ( $file_path, $fileuid, $filegid );
920 foreach ( $RT::LocalEtcPath, $RT::EtcPath, @INC ) {
921 my $tmp = File::Spec->catfile( $_, $args{File} );
922 ( $fileuid, $filegid ) = ( stat($tmp) )[ 4, 5 ];
923 if ( defined $fileuid ) {
928 unless ($file_path) {
930 qq{Couldn't load RT config file $args{'File'} as user $username / group $group.\n}
931 . qq{The file couldn't be found in $RT::LocalEtcPath and $RT::EtcPath.\n$@};
936 RT couldn't load RT config file %s as:
940 The file is owned by user %s and group %s.
942 This usually means that the user/group your webserver is running
943 as cannot read the file. Be careful not to make the permissions
944 on this file too liberal, because it contains database passwords.
945 You may need to put the webserver user in the appropriate group
946 (%s) or change permissions be able to run succesfully.
949 my $fileusername = getpwuid($fileuid);
950 my $filegroup = getgrgid($filegid);
951 my $errormessage = sprintf( $message,
952 $file_path, $fileusername, $filegroup, $filegroup );
953 die "$errormessage\n$@";
960 foreach my $o ( grep $META{$_}{'PostLoadCheck'}, $self->Options( Overridable => undef ) ) {
961 $META{$o}->{'PostLoadCheck'}->( $self, $self->Get($o) );
967 Returns list of config files found in local etc, plugins' etc
968 and main etc directories.
976 foreach my $path ( $RT::LocalEtcPath, RT->PluginDirs('etc'), $RT::EtcPath ) {
977 my $mask = File::Spec->catfile( $path, "*_Config.pm" );
978 my @files = glob $mask;
979 @files = grep !/^RT_Config\.pm$/,
980 grep $_ && /^\w+_Config\.pm$/,
981 map { s/^.*[\\\/]//; $_ } @files;
982 push @configs, sort @files;
986 @configs = grep !$seen{$_}++, @configs;
992 Takes name of the option as argument and returns its current value.
994 In the case of a user-overridable option, first checks the user's
995 preferences before looking for site-wide configuration.
997 Returns values from RT_SiteConfig, RT_Config and then the %META hash
998 of configuration variables's "Default" for this config variable,
1001 Returns different things in scalar and array contexts. For scalar
1002 options it's not that important, however for arrays and hash it's.
1003 In scalar context returns references to arrays and hashes.
1005 Use C<scalar> perl's op to force context, especially when you use
1006 C<(..., Argument => RT->Config->Get('ArrayOpt'), ...)>
1007 as perl's '=>' op doesn't change context of the right hand argument to
1008 scalar. Instead use C<(..., Argument => scalar RT->Config->Get('ArrayOpt'), ...)>.
1010 It's also important for options that have no default value(no default
1011 in F<etc/RT_Config.pm>). If you don't force scalar context then you'll
1012 get empty list and all your named args will be messed up. For example
1013 C<(arg1 => 1, arg2 => RT->Config->Get('OptionDoesNotExist'), arg3 => 3)>
1014 will result in C<(arg1 => 1, arg2 => 'arg3', 3)> what is most probably
1015 unexpected, or C<(arg1 => 1, arg2 => RT->Config->Get('ArrayOption'), arg3 => 3)>
1016 will result in C<(arg1 => 1, arg2 => 'element of option', 'another_one' => ..., 'arg3', 3)>.
1021 my ( $self, $name, $user ) = @_;
1024 if ( $user && $user->id && $META{$name}->{'Overridable'} ) {
1025 $user = $user->UserObj if $user->isa('RT::CurrentUser');
1026 my $prefs = $user->Preferences($RT::System);
1027 $res = $prefs->{$name} if $prefs;
1029 $res = $OPTIONS{$name} unless defined $res;
1030 $res = $META{$name}->{'Default'} unless defined $res;
1031 return $self->_ReturnValue( $res, $META{$name}->{'Type'} || 'SCALAR' );
1034 =head2 GetObfuscated
1036 the same as Get, except it returns Obfuscated value via Obfuscate sub
1042 my ( $name, $user ) = @_;
1043 my $obfuscate = $META{$name}->{Obfuscate};
1045 # we use two Get here is to simplify the logic of the return value
1046 # configs need obfuscation are supposed to be less, so won't be too heavy
1048 return $self->Get(@_) unless $obfuscate;
1050 my $res = $self->Get(@_);
1051 $res = $obfuscate->( $self, $res, $user );
1052 return $self->_ReturnValue( $res, $META{$name}->{'Type'} || 'SCALAR' );
1057 Set option's value to new value. Takes name of the option and new value.
1060 The new value should be scalar, array or hash depending on type of the option.
1061 If the option is not defined in meta or the default RT config then it is of
1067 my ( $self, $name ) = ( shift, shift );
1069 my $old = $OPTIONS{$name};
1070 my $type = $META{$name}->{'Type'} || 'SCALAR';
1071 if ( $type eq 'ARRAY' ) {
1072 $OPTIONS{$name} = [@_];
1073 { no warnings 'once'; no strict 'refs'; @{"RT::$name"} = (@_); }
1074 } elsif ( $type eq 'HASH' ) {
1075 $OPTIONS{$name} = {@_};
1076 { no warnings 'once'; no strict 'refs'; %{"RT::$name"} = (@_); }
1078 $OPTIONS{$name} = shift;
1079 {no warnings 'once'; no strict 'refs'; ${"RT::$name"} = $OPTIONS{$name}; }
1081 $META{$name}->{'Type'} = $type;
1082 return $self->_ReturnValue( $old, $type );
1086 my ( $self, $res, $type ) = @_;
1087 return $res unless wantarray;
1089 if ( $type eq 'ARRAY' ) {
1090 return @{ $res || [] };
1091 } elsif ( $type eq 'HASH' ) {
1092 return %{ $res || {} };
1110 unless ( $args{'File'} ) {
1111 ( $args{'Package'}, $args{'File'}, $args{'Line'} ) = caller(1);
1114 my $opt = $args{'Option'};
1117 my $name = $self->__GetNameByRef($opt);
1123 $type = $META{$name}->{'Type'} || 'SCALAR';
1126 # if option is already set we have to check where
1127 # it comes from and may be ignore it
1128 if ( exists $OPTIONS{$name} ) {
1129 if ( $type eq 'HASH' ) {
1131 @{ $args{'Value'} },
1132 @{ $args{'Value'} }%2? (undef) : (),
1133 $self->Get( $name ),
1135 } elsif ( $args{'SiteConfig'} && $args{'Extension'} ) {
1136 # if it's site config of an extension then it can only
1137 # override options that came from its main config
1138 if ( $args{'Extension'} ne $META{$name}->{'Source'}{'Extension'} ) {
1139 my %source = %{ $META{$name}->{'Source'} };
1141 "Change of config option '$name' at $args{'File'} line $args{'Line'} has been ignored."
1142 ." This option earlier has been set in $source{'File'} line $source{'Line'}."
1143 ." To overide this option use ". ($source{'Extension'}||'RT')
1148 } elsif ( !$args{'SiteConfig'} && $META{$name}->{'Source'}{'SiteConfig'} ) {
1149 # if it's core config then we can override any option that came from another
1150 # core config, but not site config
1152 my %source = %{ $META{$name}->{'Source'} };
1153 if ( $source{'Extension'} ne $args{'Extension'} ) {
1154 # as a site config is loaded earlier then its base config
1155 # then we warn only on different extensions, for example
1156 # RTIR's options is set in main site config
1158 "Change of config option '$name' at $args{'File'} line $args{'Line'} has been ignored."
1159 ." It may be ok, but we want you to be aware."
1160 ." This option has been set earlier in $source{'File'} line $source{'Line'}."
1168 $META{$name}->{'Type'} = $type;
1169 foreach (qw(Package File Line SiteConfig Extension)) {
1170 $META{$name}->{'Source'}->{$_} = $args{$_};
1172 $self->Set( $name, @{ $args{'Value'} } );
1177 our %REF_SYMBOLS = (
1187 sub __GetNameByRef {
1191 if ( !$pack && $last_pack ) {
1192 my $tmp = $self->__GetNameByRef( $ref, $last_pack );
1193 return $tmp if $tmp;
1196 $pack .= '::' unless substr( $pack, -2 ) eq '::';
1201 # scan $pack's nametable(hash)
1202 foreach my $k ( keys %{$pack} ) {
1204 # The hash for main:: has a reference to itself
1205 next if $k eq 'main::';
1207 # if the entry has a trailing '::' then
1208 # it is a link to another name space
1209 if ( substr( $k, -2 ) eq '::') {
1210 $name = $self->__GetNameByRef( $ref, $k );
1211 return $name if $name;
1214 # entry of the table with references to
1215 # SCALAR, ARRAY... and other types with
1217 my $entry = ${$pack}{$k};
1220 # get entry for type we are looking for
1221 # XXX skip references to scalars or other references.
1222 # Otherwie 5.10 goes boom. maybe we should skip any
1224 next if ref($entry) eq 'SCALAR' || ref($entry) eq 'REF';
1226 my $ref_type = ref($ref);
1228 # regex/arrayref/hashref/coderef are stored in SCALAR glob
1229 $ref_type = 'SCALAR' if $ref_type eq 'REF';
1231 my $entry_ref = *{$entry}{ $ref_type };
1232 next unless $entry_ref;
1234 # if references are equal then we've found
1235 if ( $entry_ref == $ref ) {
1237 return ( $REF_SYMBOLS{ $ref_type } || '*' ) . $pack . $k;
1252 return $META{ $_[1] };
1260 map $_->{'Section'} || 'General',
1267 my %args = ( Section => undef, Overridable => 1, Sorted => 1, @_ );
1268 my @res = keys %META;
1270 @res = grep( ( $META{$_}->{'Section'} || 'General' ) eq $args{'Section'},
1272 ) if defined $args{'Section'};
1274 if ( defined $args{'Overridable'} ) {
1276 = grep( ( $META{$_}->{'Overridable'} || 0 ) == $args{'Overridable'},
1280 if ( $args{'Sorted'} ) {
1282 ($META{$a}->{SortOrder}||9999) <=> ($META{$b}->{SortOrder}||9999)
1286 @res = sort { $a cmp $b } @res;
1291 =head2 AddOption( Name => '', Section => '', ... )
1302 Widget => '/Widgets/Form/String',
1303 WidgetArguments => {},
1307 unless ( $args{Name} ) {
1308 $RT::Logger->error("Need Name to add a new config");
1312 unless ( $args{Section} ) {
1313 $RT::Logger->error("Need Section to add a new config option");
1317 $META{ delete $args{Name} } = \%args;
1320 =head2 DeleteOption( Name => '' )
1330 if ( $args{Name} ) {
1331 delete $META{$args{Name}};
1334 $RT::Logger->error("Need Name to remove a config option");
1339 =head2 UpdateOption( Name => '' ), Section => '', ... )
1348 Overridable => undef,
1351 WidgetArguments => undef,
1355 my $name = delete $args{Name};
1358 $RT::Logger->error("Need Name to update a new config");
1362 unless ( exists $META{$name} ) {
1363 $RT::Logger->error("Config $name doesn't exist");
1367 for my $type ( keys %args ) {
1368 next unless defined $args{$type};
1369 $META{$name}{$type} = $args{$type};
1374 RT::Base->_ImportOverlays();