1 # BEGIN BPS TAGGED BLOCK {{{
5 # This software is Copyright (c) 1996-2012 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 }}}
58 use vars qw($Config $System $SystemUser $Nobody $Handle $Logger $_Privileged $_Unprivileged $_INSTALL_MODE);
73 $MasonLocalComponentRoot
78 RT->LoadGeneratedData();
86 A fully featured request tracker package
94 Load RT's config file. First, the site configuration file
95 (F<RT_SiteConfig.pm>) is loaded, in order to establish overall site
96 settings like hostname and name of RT instance. Then, the core
97 configuration file (F<RT_Config.pm>) is loaded to set fallback values
98 for all settings; it bases some values on settings from the site
101 In order for the core configuration to not override the site's
102 settings, the function C<Set> is used; it only sets values if they
103 have not been set already.
109 $Config = RT::Config->new;
110 $Config->LoadConfigs;
113 # RT::Essentials mistakenly recommends that WebPath be set to '/'.
114 # If the user does that, do what they mean.
115 $RT::WebPath = '' if ($RT::WebPath eq '/');
117 # fix relative LogDir and GnuPG homedir
118 unless ( File::Spec->file_name_is_absolute( $Config->Get('LogDir') ) ) {
119 $Config->Set( LogDir =>
120 File::Spec->catfile( $BasePath, $Config->Get('LogDir') ) );
123 my $gpgopts = $Config->Get('GnuPGOptions');
124 unless ( File::Spec->file_name_is_absolute( $gpgopts->{homedir} ) ) {
125 $gpgopts->{homedir} = File::Spec->catfile( $BasePath, $gpgopts->{homedir} );
133 L<Connects to the database|/ConnectToDatabase>, L<initilizes system
134 objects|/InitSystemObjects>, L<preloads classes|/InitClasses>, L<sets
135 up logging|/InitLogging>, and L<loads plugins|/InitPlugins>.
143 CheckPerlRequirements();
147 #Get a database connection
154 RT->Config->PostLoadCheck;
158 =head2 ConnectToDatabase
160 Get a database connection. See also L</Handle>.
164 sub ConnectToDatabase {
166 $Handle = RT::Handle->new unless $Handle;
173 Create the Logger object and set up signal handlers.
181 # We have to set the record separator ($, man perlvar)
182 # or Log::Dispatch starts getting
183 # really pissy, as some other module we use unsets it.
185 use Log::Dispatch 1.6;
188 map( { $_ => } 0..7 ),
193 error => 4, 'err' => 4,
194 critical => 5, crit => 5,
196 emergency => 7, emerg => 7,
199 unless ( $RT::Logger ) {
201 $RT::Logger = Log::Dispatch->new;
203 my $stack_from_level;
204 if ( $stack_from_level = RT->Config->Get('LogStackTraces') ) {
205 # if option has old style '\d'(true) value
206 $stack_from_level = 0 if $stack_from_level =~ /^\d+$/;
207 $stack_from_level = $level_to_num{ $stack_from_level } || 0;
209 $stack_from_level = 99; # don't log
212 my $simple_cb = sub {
213 # if this code throw any warning we can get segfault
217 # skip Log::* stack frames
219 $frame++ while caller($frame) && caller($frame) =~ /^Log::/;
220 my ($package, $filename, $line) = caller($frame);
222 $p{'message'} =~ s/(?:\r*\n)+$//;
223 return "[". gmtime(time) ."] [". $p{'level'} ."]: "
224 . $p{'message'} ." ($filename:$line)\n";
227 my $syslog_cb = sub {
228 # if this code throw any warning we can get segfault
232 my $frame = 0; # stack frame index
233 # skip Log::* stack frames
234 $frame++ while caller($frame) && caller($frame) =~ /^Log::/;
235 my ($package, $filename, $line) = caller($frame);
237 # syswrite() cannot take utf8; turn it off here.
238 Encode::_utf8_off($p{message});
240 $p{message} =~ s/(?:\r*\n)+$//;
241 if ($p{level} eq 'debug') {
242 return "$p{message}\n";
244 return "$p{message} ($filename:$line)\n";
251 return $p{'message'} unless $level_to_num{ $p{'level'} } >= $stack_from_level;
253 require Devel::StackTrace;
254 my $trace = Devel::StackTrace->new( ignore_class => [ 'Log::Dispatch', 'Log::Dispatch::Base' ] );
255 return $p{'message'} . $trace->as_string;
257 # skip calling of the Log::* subroutins
259 $frame++ while caller($frame) && caller($frame) =~ /^Log::/;
260 $frame++ while caller($frame) && (caller($frame))[3] =~ /^Log::/;
262 $p{'message'} .= "\nStack trace:\n";
263 while( my ($package, $filename, $line, $sub) = caller($frame++) ) {
264 $p{'message'} .= "\t$sub(...) called at $filename:$line\n";
266 return $p{'message'};
269 if ( $Config->Get('LogToFile') ) {
270 my ($filename, $logdir) = (
271 $Config->Get('LogToFileNamed') || 'rt.log',
272 $Config->Get('LogDir') || File::Spec->catdir( $VarPath, 'log' ),
274 if ( $filename =~ m![/\\]! ) { # looks like an absolute path.
275 ($logdir) = $filename =~ m{^(.*[/\\])};
278 $filename = File::Spec->catfile( $logdir, $filename );
281 unless ( -d $logdir && ( ( -f $filename && -w $filename ) || -w $logdir ) ) {
282 # localizing here would be hard when we don't have a current user yet
283 die "Log file '$filename' couldn't be written or created.\n RT can't run.";
286 require Log::Dispatch::File;
287 $RT::Logger->add( Log::Dispatch::File->new
289 min_level=> $Config->Get('LogToFile'),
290 filename=> $filename,
292 callbacks => [ $simple_cb, $stack_cb ],
295 if ( $Config->Get('LogToScreen') ) {
296 require Log::Dispatch::Screen;
297 $RT::Logger->add( Log::Dispatch::Screen->new
299 min_level => $Config->Get('LogToScreen'),
300 callbacks => [ $simple_cb, $stack_cb ],
304 if ( $Config->Get('LogToSyslog') ) {
305 require Log::Dispatch::Syslog;
306 $RT::Logger->add(Log::Dispatch::Syslog->new
309 min_level => $Config->Get('LogToSyslog'),
310 callbacks => [ $syslog_cb, $stack_cb ],
312 $Config->Get('LogToSyslogConf'),
316 InitSignalHandlers(%arg);
319 sub InitSignalHandlers {
324 ## This is the default handling of warnings and die'ings in the code
325 ## (including other used modules - maybe except for errors catched by
326 ## Mason). It will log all problems through the standard logging
327 ## mechanism (see above).
329 unless ( $arg{'NoSignalHandlers'} ) {
331 $SIG{__WARN__} = sub {
332 # The 'wide character' warnings has to be silenced for now, at least
333 # until HTML::Mason offers a sane way to process both raw output and
335 # use 'goto &foo' syntax to hide ANON sub from stack
336 if( index($_[0], 'Wide character in ') != 0 ) {
337 unshift @_, $RT::Logger, qw(level warning message);
338 goto &Log::Dispatch::log;
342 #When we call die, trap it and log->crit with the value of the die.
344 $SIG{__DIE__} = sub {
345 # if we are not in eval and perl is not parsing code
346 # then rollback transactions and log RT error
347 unless ($^S || !defined $^S ) {
348 $RT::Handle->Rollback(1) if $RT::Handle;
349 $RT::Logger->crit("$_[0]") if $RT::Logger;
358 sub CheckPerlRequirements {
359 if ($^V < 5.008003) {
360 die sprintf "RT requires Perl v5.8.3 or newer. Your current Perl is v%vd\n", $^V;
363 # use $error here so the following "die" can still affect the global $@
370 require Scalar::Util;
371 Scalar::Util::weaken($y);
379 RT requires the Scalar::Util module be built with support for the 'weaken'
382 It is sometimes the case that operating system upgrades will replace
383 a working Scalar::Util with a non-working one. If your system was working
384 correctly up until now, this is likely the cause of the problem.
386 Please reinstall Scalar::Util, being careful to let it build with your C
387 compiler. Usually this is as simple as running the following command as
390 perl -MCPAN -e'install Scalar::Util'
399 Load all modules that define base classes.
404 shift if @_%2; # so we can call it as a function or method
407 require RT::Transactions;
408 require RT::Attachments;
410 require RT::Principals;
411 require RT::CurrentUser;
412 require RT::Templates;
414 require RT::ScripActions;
415 require RT::ScripConditions;
418 require RT::GroupMembers;
419 require RT::CustomFields;
420 require RT::CustomFieldValues;
421 require RT::ObjectCustomFields;
422 require RT::ObjectCustomFieldValues;
423 require RT::Attributes;
424 require RT::Dashboard;
425 require RT::Approval;
426 require RT::Lifecycle;
429 require RT::Articles;
432 require RT::ObjectClass;
433 require RT::ObjectClasses;
434 require RT::ObjectTopic;
435 require RT::ObjectTopics;
439 # on a cold server (just after restart) people could have an object
440 # in the session, as we deserialize it so we never call constructor
441 # of the class, so the list of accessible fields is empty and we die
442 # with "Method xxx is not implemented in RT::SomeClass"
444 # without this, we also can never call _ClassAccessible, because we
445 # won't have filled RT::Record::_TABLE_ATTR
446 $_->_BuildTableAttributes foreach qw(
461 RT::ObjectCustomField
462 RT::ObjectCustomFieldValue
473 if ( $args{'Heavy'} ) {
474 # load scrips' modules
475 my $scrips = RT::Scrips->new(RT->SystemUser);
476 $scrips->Limit( FIELD => 'Stage', OPERATOR => '!=', VALUE => 'Disabled' );
477 while ( my $scrip = $scrips->Next ) {
479 eval { $scrip->LoadModules } or
480 $RT::Logger->error("Invalid Scrip ".$scrip->Id.". Unable to load the Action or Condition. ".
481 "You should delete or repair this Scrip in the admin UI.\n$@\n");
484 foreach my $class ( grep $_, RT->Config->Get('CustomFieldValuesSources') ) {
486 eval "require $class; 1" or $RT::Logger->error(
487 "Class '$class' is listed in CustomFieldValuesSources option"
488 ." in the config, but we failed to load it:\n$@\n"
495 =head2 InitSystemObjects
497 Initializes system objects: C<$RT::System>, C<< RT->SystemUser >>
498 and C<< RT->Nobody >>.
502 sub InitSystemObjects {
504 #RT's system user is a genuine database user. its id lives here
505 require RT::CurrentUser;
506 $SystemUser = RT::CurrentUser->new;
507 $SystemUser->LoadByName('RT_System');
509 #RT's "nobody user" is a genuine database user. its ID lives here.
510 $Nobody = RT::CurrentUser->new;
511 $Nobody->LoadByName('Nobody');
514 $System = RT::System->new( $SystemUser );
521 Returns the current L<config object|RT::Config>, but note that
522 you must L<load config|/LoadConfig> first otherwise this method
525 Method can be called as class method.
529 sub Config { return $Config || shift->LoadConfig(); }
531 =head2 DatabaseHandle
533 Returns the current L<database handle object|RT::Handle>.
535 See also L</ConnectToDatabase>.
539 sub DatabaseHandle { return $Handle }
543 Returns the logger. See also L</InitLogging>.
547 sub Logger { return $Logger }
551 Returns the current L<system object|RT::System>. See also
552 L</InitSystemObjects>.
556 sub System { return $System }
560 Returns the system user's object, it's object of
561 L<RT::CurrentUser> class that represents the system. See also
562 L</InitSystemObjects>.
566 sub SystemUser { return $SystemUser }
570 Returns object of Nobody. It's object of L<RT::CurrentUser> class
571 that represents a user who can own ticket and nothing else. See
572 also L</InitSystemObjects>.
576 sub Nobody { return $Nobody }
578 sub PrivilegedUsers {
580 $_Privileged = RT::Group->new(RT->SystemUser);
581 $_Privileged->LoadSystemInternalGroup('Privileged');
586 sub UnprivilegedUsers {
587 if (!$_Unprivileged) {
588 $_Unprivileged = RT::Group->new(RT->SystemUser);
589 $_Unprivileged->LoadSystemInternalGroup('Unprivileged');
591 return $_Unprivileged;
597 Returns a listref of all Plugins currently configured for this RT instance.
598 You can define plugins by adding them to the @Plugins list in your RT_SiteConfig
606 $self->InitPluginPaths;
607 @PLUGINS = $self->InitPlugins;
614 Takes an optional subdir (e.g. po, lib, etc.) and returns a list of
615 directories from plugins where that subdirectory exists.
617 This code does not check plugin names, plugin validitity, or load
618 plugins (see L</InitPlugins>) in any way, and requires that RT's
619 configuration have been already loaded.
630 foreach my $plugin (grep $_, RT->Config->Get('Plugins')) {
631 my $path = RT::Plugin->new( name => $plugin )->Path( $subdir );
632 next unless -d $path;
638 =head2 InitPluginPaths
640 Push plugins' lib paths into @INC right after F<local/lib>.
641 In case F<local/lib> isn't in @INC, append them to @INC
645 sub InitPluginPaths {
646 my $self = shift || __PACKAGE__;
648 my @lib_dirs = $self->PluginDirs('lib');
653 if ( Cwd::realpath($_) eq $RT::LocalLibPath) {
654 push @tmp_inc, $_, @lib_dirs;
661 # append @lib_dirs in case $RT::LocalLibPath isn't in @INC
662 push @tmp_inc, @lib_dirs unless $added;
665 @INC = grep !$seen{$_}++, @tmp_inc;
670 Initialize all Plugins found in the RT configuration file, setting up
671 their lib and L<HTML::Mason> component roots.
679 foreach my $plugin (grep $_, RT->Config->Get('Plugins')) {
681 die $UNIVERSAL::require::ERROR if ($UNIVERSAL::require::ERROR);
682 push @plugins, RT::Plugin->new(name =>$plugin);
691 $_INSTALL_MODE = shift;
693 require RT::CurrentUser;
694 $SystemUser = RT::CurrentUser->new();
697 return $_INSTALL_MODE;
700 sub LoadGeneratedData {
702 my $pm_path = ( File::Spec->splitpath( $INC{'RT.pm'} ) )[1];
704 require "$pm_path/RT/Generated.pm" || die "Couldn't load RT::Generated: $@";
705 $class->CanonicalizeGeneratedPaths();
708 sub CanonicalizeGeneratedPaths {
710 unless ( File::Spec->file_name_is_absolute($EtcPath) ) {
712 # if BasePath exists and is absolute, we won't infer it from $INC{'RT.pm'}.
713 # otherwise RT.pm will make the source dir(where we configure RT) be the
714 # BasePath instead of the one specified by --prefix
715 unless ( -d $BasePath
716 && File::Spec->file_name_is_absolute($BasePath) )
718 my $pm_path = ( File::Spec->splitpath( $INC{'RT.pm'} ) )[1];
720 # need rel2abs here is to make sure path is absolute, since $INC{'RT.pm'}
721 # is not always absolute
722 $BasePath = File::Spec->rel2abs(
723 File::Spec->catdir( $pm_path, File::Spec->updir ) );
726 $BasePath = Cwd::realpath($BasePath);
729 qw/EtcPath BinPath SbinPath VarPath LocalPath LocalEtcPath
730 LocalLibPath LexiconPath LocalLexiconPath PluginPath
731 LocalPluginPath MasonComponentRoot MasonLocalComponentRoot
732 MasonDataDir MasonSessionDir/
737 # just change relative ones
738 $$path = File::Spec->catfile( $BasePath, $$path )
739 unless File::Spec->file_name_is_absolute($$path);
747 helper method to add js files to C<JSFiles> config.
748 to add extra css files, you can add the following line
749 in the plugin's main file:
751 RT->AddJavaScript( 'foo.js', 'bar.js' );
758 my @old = RT->Config->Get('JSFiles');
759 RT->Config->Set( 'JSFiles', @old, @_ );
760 return RT->Config->Get('JSFiles');
763 =head2 AddStyleSheets
765 helper method to add css files to C<CSSFiles> config
767 to add extra css files, you can add the following line
768 in the plugin's main file:
770 RT->AddStyleSheets( 'foo.css', 'bar.css' );
776 my @old = RT->Config->Get('CSSFiles');
777 RT->Config->Set( 'CSSFiles', @old, @_ );
778 return RT->Config->Get('CSSFiles');
783 helper method of RT->Config->Get('JSFiles')
788 return RT->Config->Get('JSFiles');
793 helper method of RT->Config->Get('CSSFiles')
798 return RT->Config->Get('CSSFiles');
803 Please report them to rt-bugs@bestpractical.com, if you know what's
804 broken and have at least some idea of what needs to be fixed.
806 If you're not sure what's going on, report them rt-devel@lists.bestpractical.com.
811 L<DBIx::SearchBuilder>
816 RT::Base->_ImportOverlays();