rt/lib/RT.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
   6 #                                          <sales@bestpractical.com>
   7 #
   8 # (Except where explicitly superseded by other copyright notices)
   9 #
  10 #
  11 # LICENSE:
  12 #
  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
  16 # from www.gnu.org.
  17 #
  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.
  22 #
  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.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  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.)
  37 #
  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.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 use strict;
  50 use warnings;
  51
  52 package RT;
  53
  54
  55 use File::Spec ();
  56 use Cwd ();
  57
  58 use vars qw($Config $System $SystemUser $Nobody $Handle $Logger $_Privileged $_Unprivileged $_INSTALL_MODE);
  59
  60 use vars qw($BasePath
  61  $EtcPath
  62  $BinPath
  63  $SbinPath
  64  $VarPath
  65  $LexiconPath
  66  $PluginPath
  67  $LocalPath
  68  $LocalEtcPath
  69  $LocalLibPath
  70  $LocalLexiconPath
  71  $LocalPluginPath
  72  $MasonComponentRoot
  73  $MasonLocalComponentRoot
  74  $MasonDataDir
  75  $MasonSessionDir);
  76
  77
  78 RT->LoadGeneratedData();
  79
  80 =head1 NAME
  81
  82 RT - Request Tracker
  83
  84 =head1 SYNOPSIS
  85
  86 A fully featured request tracker package
  87
  88 =head1 DESCRIPTION
  89
  90 =head2 INITIALIZATION
  91
  92 =head2 LoadConfig
  93
  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
  99 configuration file.
 100
 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.
 104
 105 =cut
 106
 107 sub LoadConfig {
 108     require RT::Config;
 109     $Config = RT::Config->new;
 110     $Config->LoadConfigs;
 111     require RT::I18N;
 112
 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 '/');
 116
 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') ) );
 121     }
 122
 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} );
 126     }
 127
 128     return $Config;
 129 }
 130
 131 =head2 Init
 132
 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>.
 136
 137 =cut
 138
 139 sub Init {
 140
 141     CheckPerlRequirements();
 142
 143     InitPluginPaths();
 144
 145     #Get a database connection
 146     ConnectToDatabase();
 147     InitSystemObjects();
 148     InitClasses();
 149     InitLogging();
 150     InitPlugins();
 151     RT::I18N->Init;
 152     RT->Config->PostLoadCheck;
 153
 154 }
 155
 156 =head2 ConnectToDatabase
 157
 158 Get a database connection. See also L</Handle>.
 159
 160 =cut
 161
 162 sub ConnectToDatabase {
 163     require RT::Handle;
 164     $Handle = RT::Handle->new unless $Handle;
 165     $Handle->Connect;
 166     return $Handle;
 167 }
 168
 169 =head2 InitLogging
 170
 171 Create the Logger object and set up signal handlers.
 172
 173 =cut
 174
 175 sub InitLogging {
 176
 177     my %arg = @_;
 178
 179     # We have to set the record separator ($, man perlvar)
 180     # or Log::Dispatch starts getting
 181     # really pissy, as some other module we use unsets it.
 182     $, = '';
 183     use Log::Dispatch 1.6;
 184
 185     my %level_to_num = (
 186         map( { $_ => } 0..7 ),
 187         debug     => 0,
 188         info      => 1,
 189         notice    => 2,
 190         warning   => 3,
 191         error     => 4, 'err' => 4,
 192         critical  => 5, crit  => 5,
 193         alert     => 6,
 194         emergency => 7, emerg => 7,
 195     );
 196
 197     unless ( $RT::Logger ) {
 198
 199         $RT::Logger = Log::Dispatch->new;
 200
 201         my $stack_from_level;
 202         if ( $stack_from_level = RT->Config->Get('LogStackTraces') ) {
 203             # if option has old style '\d'(true) value
 204             $stack_from_level = 0 if $stack_from_level =~ /^\d+$/;
 205             $stack_from_level = $level_to_num{ $stack_from_level } || 0;
 206         } else {
 207             $stack_from_level = 99; # don't log
 208         }
 209
 210         my $simple_cb = sub {
 211             # if this code throw any warning we can get segfault
 212             no warnings;
 213             my %p = @_;
 214
 215             # skip Log::* stack frames
 216             my $frame = 0;
 217             $frame++ while caller($frame) && caller($frame) =~ /^Log::/;
 218             my ($package, $filename, $line) = caller($frame);
 219
 220             $p{'message'} =~ s/(?:\r*\n)+$//;
 221             return "[". gmtime(time) ."] [". $p{'level'} ."]: "
 222                 . $p{'message'} ." ($filename:$line)\n";
 223         };
 224
 225         my $syslog_cb = sub {
 226             # if this code throw any warning we can get segfault
 227             no warnings;
 228             my %p = @_;
 229
 230             my $frame = 0; # stack frame index
 231             # skip Log::* stack frames
 232             $frame++ while caller($frame) && caller($frame) =~ /^Log::/;
 233             my ($package, $filename, $line) = caller($frame);
 234
 235             # syswrite() cannot take utf8; turn it off here.
 236             Encode::_utf8_off($p{message});
 237
 238             $p{message} =~ s/(?:\r*\n)+$//;
 239             if ($p{level} eq 'debug') {
 240                 return "$p{message}\n";
 241             } else {
 242                 return "$p{message} ($filename:$line)\n";
 243             }
 244         };
 245
 246         my $stack_cb = sub {
 247             no warnings;
 248             my %p = @_;
 249             return $p{'message'} unless $level_to_num{ $p{'level'} } >= $stack_from_level;
 250
 251             require Devel::StackTrace;
 252             my $trace = Devel::StackTrace->new( ignore_class => [ 'Log::Dispatch', 'Log::Dispatch::Base' ] );
 253             return $p{'message'} . $trace->as_string;
 254
 255             # skip calling of the Log::* subroutins
 256             my $frame = 0;
 257             $frame++ while caller($frame) && caller($frame) =~ /^Log::/;
 258             $frame++ while caller($frame) && (caller($frame))[3] =~ /^Log::/;
 259
 260             $p{'message'} .= "\nStack trace:\n";
 261             while( my ($package, $filename, $line, $sub) = caller($frame++) ) {
 262                 $p{'message'} .= "\t$sub(...) called at $filename:$line\n";
 263             }
 264             return $p{'message'};
 265         };
 266
 267         if ( $Config->Get('LogToFile') ) {
 268             my ($filename, $logdir) = (
 269                 $Config->Get('LogToFileNamed') || 'rt.log',
 270                 $Config->Get('LogDir') || File::Spec->catdir( $VarPath, 'log' ),
 271             );
 272             if ( $filename =~ m![/\\]! ) { # looks like an absolute path.
 273                 ($logdir) = $filename =~ m{^(.*[/\\])};
 274             }
 275             else {
 276                 $filename = File::Spec->catfile( $logdir, $filename );
 277             }
 278
 279             unless ( -d $logdir && ( ( -f $filename && -w $filename ) || -w $logdir ) ) {
 280                 # localizing here would be hard when we don't have a current user yet
 281                 die "Log file '$filename' couldn't be written or created.\n RT can't run.";
 282             }
 283
 284             require Log::Dispatch::File;
 285             $RT::Logger->add( Log::Dispatch::File->new
 286                            ( name=>'file',
 287                              min_level=> $Config->Get('LogToFile'),
 288                              filename=> $filename,
 289                              mode=>'append',
 290                              callbacks => [ $simple_cb, $stack_cb ],
 291                            ));
 292         }
 293         if ( $Config->Get('LogToScreen') ) {
 294             require Log::Dispatch::Screen;
 295             $RT::Logger->add( Log::Dispatch::Screen->new
 296                          ( name => 'screen',
 297                            min_level => $Config->Get('LogToScreen'),
 298                            callbacks => [ $simple_cb, $stack_cb ],
 299                            stderr => 1,
 300                          ));
 301         }
 302         if ( $Config->Get('LogToSyslog') ) {
 303             require Log::Dispatch::Syslog;
 304             $RT::Logger->add(Log::Dispatch::Syslog->new
 305                          ( name => 'syslog',
 306                            ident => 'RT',
 307                            min_level => $Config->Get('LogToSyslog'),
 308                            callbacks => [ $syslog_cb, $stack_cb ],
 309                            stderr => 1,
 310                            $Config->Get('LogToSyslogConf'),
 311                          ));
 312         }
 313     }
 314     InitSignalHandlers(%arg);
 315 }
 316
 317 sub InitSignalHandlers {
 318
 319     my %arg = @_;
 320     return if $arg{'NoSignalHandlers'};
 321
 322 # Signal handlers
 323 ## This is the default handling of warnings and die'ings in the code
 324 ## (including other used modules - maybe except for errors catched by
 325 ## Mason).  It will log all problems through the standard logging
 326 ## mechanism (see above).
 327
 328     $SIG{__WARN__} = sub {
 329         # The 'wide character' warnings has to be silenced for now, at least
 330         # until HTML::Mason offers a sane way to process both raw output and
 331         # unicode strings.
 332         # use 'goto &foo' syntax to hide ANON sub from stack
 333         if( index($_[0], 'Wide character in ') != 0 ) {
 334             unshift @_, $RT::Logger, qw(level warning message);
 335             goto &Log::Dispatch::log;
 336         }
 337     };
 338
 339 #When we call die, trap it and log->crit with the value of the die.
 340
 341     $SIG{__DIE__}  = sub {
 342         # if we are not in eval and perl is not parsing code
 343         # then rollback transactions and log RT error
 344         unless ($^S || !defined $^S ) {
 345             $RT::Handle->Rollback(1) if $RT::Handle;
 346             $RT::Logger->crit("$_[0]") if $RT::Logger;
 347         }
 348         die $_[0];
 349     };
 350 }
 351
 352
 353 sub CheckPerlRequirements {
 354     if ($^V < 5.008003) {
 355         die sprintf "RT requires Perl v5.8.3 or newer.  Your current Perl is v%vd\n", $^V;
 356     }
 357
 358     # use $error here so the following "die" can still affect the global $@
 359     my $error;
 360     {
 361         local $@;
 362         eval {
 363             my $x = '';
 364             my $y = \$x;
 365             require Scalar::Util;
 366             Scalar::Util::weaken($y);
 367         };
 368         $error = $@;
 369     }
 370
 371     if ($error) {
 372         die <<"EOF";
 373
 374 RT requires the Scalar::Util module be built with support for  the 'weaken'
 375 function.
 376
 377 It is sometimes the case that operating system upgrades will replace
 378 a working Scalar::Util with a non-working one. If your system was working
 379 correctly up until now, this is likely the cause of the problem.
 380
 381 Please reinstall Scalar::Util, being careful to let it build with your C
 382 compiler. Usually this is as simple as running the following command as
 383 root.
 384
 385     perl -MCPAN -e'install Scalar::Util'
 386
 387 EOF
 388
 389     }
 390 }
 391
 392 =head2 InitClasses
 393
 394 Load all modules that define base classes.
 395
 396 =cut
 397
 398 sub InitClasses {
 399     shift if @_%2; # so we can call it as a function or method
 400     my %args = (@_);
 401     require RT::Tickets;
 402     require RT::Transactions;
 403     require RT::Attachments;
 404     require RT::Users;
 405     require RT::Principals;
 406     require RT::CurrentUser;
 407     require RT::Templates;
 408     require RT::Queues;
 409     require RT::ScripActions;
 410     require RT::ScripConditions;
 411     require RT::Scrips;
 412     require RT::Groups;
 413     require RT::GroupMembers;
 414     require RT::CustomFields;
 415     require RT::CustomFieldValues;
 416     require RT::ObjectCustomFields;
 417     require RT::ObjectCustomFieldValues;
 418     require RT::Attributes;
 419     require RT::Dashboard;
 420     require RT::Approval;
 421     require RT::Lifecycle;
 422     require RT::Link;
 423     require RT::Links;
 424     require RT::Article;
 425     require RT::Articles;
 426     require RT::Class;
 427     require RT::Classes;
 428     require RT::ObjectClass;
 429     require RT::ObjectClasses;
 430     require RT::ObjectTopic;
 431     require RT::ObjectTopics;
 432     require RT::Topic;
 433     require RT::Topics;
 434
 435     # on a cold server (just after restart) people could have an object
 436     # in the session, as we deserialize it so we never call constructor
 437     # of the class, so the list of accessible fields is empty and we die
 438     # with "Method xxx is not implemented in RT::SomeClass"
 439
 440     # without this, we also can never call _ClassAccessible, because we
 441     # won't have filled RT::Record::_TABLE_ATTR
 442     $_->_BuildTableAttributes foreach qw(
 443         RT::Ticket
 444         RT::Transaction
 445         RT::Attachment
 446         RT::User
 447         RT::Principal
 448         RT::Template
 449         RT::Queue
 450         RT::ScripAction
 451         RT::ScripCondition
 452         RT::Scrip
 453         RT::Group
 454         RT::GroupMember
 455         RT::CustomField
 456         RT::CustomFieldValue
 457         RT::ObjectCustomField
 458         RT::ObjectCustomFieldValue
 459         RT::Attribute
 460         RT::ACE
 461         RT::Link
 462         RT::Article
 463         RT::Class
 464         RT::ObjectClass
 465         RT::ObjectTopic
 466         RT::Topic
 467     );
 468
 469     if ( $args{'Heavy'} ) {
 470         # load scrips' modules
 471         my $scrips = RT::Scrips->new(RT->SystemUser);
 472         $scrips->Limit( FIELD => 'Stage', OPERATOR => '!=', VALUE => 'Disabled' );
 473         while ( my $scrip = $scrips->Next ) {
 474             local $@;
 475             eval { $scrip->LoadModules } or
 476                 $RT::Logger->error("Invalid Scrip ".$scrip->Id.".  Unable to load the Action or Condition.  ".
 477                                    "You should delete or repair this Scrip in the admin UI.\n$@\n");
 478         }
 479
 480         foreach my $class ( grep $_, RT->Config->Get('CustomFieldValuesSources') ) {
 481             local $@;
 482             eval "require $class; 1" or $RT::Logger->error(
 483                 "Class '$class' is listed in CustomFieldValuesSources option"
 484                 ." in the config, but we failed to load it:\n$@\n"
 485             );
 486         }
 487
 488     }
 489 }
 490
 491 =head2 InitSystemObjects
 492
 493 Initializes system objects: C<$RT::System>, C<< RT->SystemUser >>
 494 and C<< RT->Nobody >>.
 495
 496 =cut
 497
 498 sub InitSystemObjects {
 499
 500     #RT's system user is a genuine database user. its id lives here
 501     require RT::CurrentUser;
 502     $SystemUser = RT::CurrentUser->new;
 503     $SystemUser->LoadByName('RT_System');
 504
 505     #RT's "nobody user" is a genuine database user. its ID lives here.
 506     $Nobody = RT::CurrentUser->new;
 507     $Nobody->LoadByName('Nobody');
 508
 509     require RT::System;
 510     $System = RT::System->new( $SystemUser );
 511 }
 512
 513 =head1 CLASS METHODS
 514
 515 =head2 Config
 516
 517 Returns the current L<config object|RT::Config>, but note that
 518 you must L<load config|/LoadConfig> first otherwise this method
 519 returns undef.
 520
 521 Method can be called as class method.
 522
 523 =cut
 524
 525 sub Config { return $Config || shift->LoadConfig(); }
 526
 527 =head2 DatabaseHandle
 528
 529 Returns the current L<database handle object|RT::Handle>.
 530
 531 See also L</ConnectToDatabase>.
 532
 533 =cut
 534
 535 sub DatabaseHandle { return $Handle }
 536
 537 =head2 Logger
 538
 539 Returns the logger. See also L</InitLogging>.
 540
 541 =cut
 542
 543 sub Logger { return $Logger }
 544
 545 =head2 System
 546
 547 Returns the current L<system object|RT::System>. See also
 548 L</InitSystemObjects>.
 549
 550 =cut
 551
 552 sub System { return $System }
 553
 554 =head2 SystemUser
 555
 556 Returns the system user's object, it's object of
 557 L<RT::CurrentUser> class that represents the system. See also
 558 L</InitSystemObjects>.
 559
 560 =cut
 561
 562 sub SystemUser { return $SystemUser }
 563
 564 =head2 Nobody
 565
 566 Returns object of Nobody. It's object of L<RT::CurrentUser> class
 567 that represents a user who can own ticket and nothing else. See
 568 also L</InitSystemObjects>.
 569
 570 =cut
 571
 572 sub Nobody { return $Nobody }
 573
 574 sub PrivilegedUsers {
 575     if (!$_Privileged) {
 576     $_Privileged = RT::Group->new(RT->SystemUser);
 577     $_Privileged->LoadSystemInternalGroup('Privileged');
 578     }
 579     return $_Privileged;
 580 }
 581
 582 sub UnprivilegedUsers {
 583     if (!$_Unprivileged) {
 584     $_Unprivileged = RT::Group->new(RT->SystemUser);
 585     $_Unprivileged->LoadSystemInternalGroup('Unprivileged');
 586     }
 587     return $_Unprivileged;
 588 }
 589
 590
 591 =head2 Plugins
 592
 593 Returns a listref of all Plugins currently configured for this RT instance.
 594 You can define plugins by adding them to the @Plugins list in your RT_SiteConfig
 595
 596 =cut
 597
 598 our @PLUGINS = ();
 599 sub Plugins {
 600     my $self = shift;
 601     unless (@PLUGINS) {
 602         $self->InitPluginPaths;
 603         @PLUGINS = $self->InitPlugins;
 604     }
 605     return \@PLUGINS;
 606 }
 607
 608 =head2 PluginDirs
 609
 610 Takes an optional subdir (e.g. po, lib, etc.) and returns a list of
 611 directories from plugins where that subdirectory exists.
 612
 613 This code does not check plugin names, plugin validitity, or load
 614 plugins (see L</InitPlugins>) in any way, and requires that RT's
 615 configuration have been already loaded.
 616
 617 =cut
 618
 619 sub PluginDirs {
 620     my $self = shift;
 621     my $subdir = shift;
 622
 623     require RT::Plugin;
 624
 625     my @res;
 626     foreach my $plugin (grep $_, RT->Config->Get('Plugins')) {
 627         my $path = RT::Plugin->new( name => $plugin )->Path( $subdir );
 628         next unless -d $path;
 629         push @res, $path;
 630     }
 631     return @res;
 632 }
 633
 634 =head2 InitPluginPaths
 635
 636 Push plugins' lib paths into @INC right after F<local/lib>.
 637 In case F<local/lib> isn't in @INC, append them to @INC
 638
 639 =cut
 640
 641 sub InitPluginPaths {
 642     my $self = shift || __PACKAGE__;
 643
 644     my @lib_dirs = $self->PluginDirs('lib');
 645
 646     my @tmp_inc;
 647     my $added;
 648     for (@INC) {
 649         if ( Cwd::realpath($_) eq $RT::LocalLibPath) {
 650             push @tmp_inc, $_, @lib_dirs;
 651             $added = 1;
 652         } else {
 653             push @tmp_inc, $_;
 654         }
 655     }
 656
 657     # append @lib_dirs in case $RT::LocalLibPath isn't in @INC
 658     push @tmp_inc, @lib_dirs unless $added;
 659
 660     my %seen;
 661     @INC = grep !$seen{$_}++, @tmp_inc;
 662 }
 663
 664 =head2 InitPlugins
 665
 666 Initialize all Plugins found in the RT configuration file, setting up
 667 their lib and L<HTML::Mason> component roots.
 668
 669 =cut
 670
 671 sub InitPlugins {
 672     my $self    = shift;
 673     my @plugins;
 674     require RT::Plugin;
 675     foreach my $plugin (grep $_, RT->Config->Get('Plugins')) {
 676         $plugin->require;
 677         die $UNIVERSAL::require::ERROR if ($UNIVERSAL::require::ERROR);
 678         push @plugins, RT::Plugin->new(name =>$plugin);
 679     }
 680     return @plugins;
 681 }
 682
 683
 684 sub InstallMode {
 685     my $self = shift;
 686     if (@_) {
 687         my ($integrity, $state, $msg) = RT::Handle->CheckIntegrity;
 688         if ($_[0] and $integrity) {
 689             # Trying to turn install mode on but we have a good DB!
 690             require Carp;
 691             $RT::Logger->error(
 692                 Carp::longmess("Something tried to turn on InstallMode but we have DB integrity!")
 693             );
 694         }
 695         else {
 696             $_INSTALL_MODE = shift;
 697             if($_INSTALL_MODE) {
 698                 require RT::CurrentUser;
 699                $SystemUser = RT::CurrentUser->new();
 700             }
 701         }
 702     }
 703     return $_INSTALL_MODE;
 704 }
 705
 706 sub LoadGeneratedData {
 707     my $class = shift;
 708     my $pm_path = ( File::Spec->splitpath( $INC{'RT.pm'} ) )[1];
 709
 710     require "$pm_path/RT/Generated.pm" || die "Couldn't load RT::Generated: $@";
 711     $class->CanonicalizeGeneratedPaths();
 712 }
 713
 714 sub CanonicalizeGeneratedPaths {
 715     my $class = shift;
 716     unless ( File::Spec->file_name_is_absolute($EtcPath) ) {
 717
 718    # if BasePath exists and is absolute, we won't infer it from $INC{'RT.pm'}.
 719    # otherwise RT.pm will make the source dir(where we configure RT) be the
 720    # BasePath instead of the one specified by --prefix
 721         unless ( -d $BasePath
 722                  && File::Spec->file_name_is_absolute($BasePath) )
 723         {
 724             my $pm_path = ( File::Spec->splitpath( $INC{'RT.pm'} ) )[1];
 725
 726      # need rel2abs here is to make sure path is absolute, since $INC{'RT.pm'}
 727      # is not always absolute
 728             $BasePath = File::Spec->rel2abs(
 729                           File::Spec->catdir( $pm_path, File::Spec->updir ) );
 730         }
 731
 732         $BasePath = Cwd::realpath($BasePath);
 733
 734         for my $path (
 735                     qw/EtcPath BinPath SbinPath VarPath LocalPath LocalEtcPath
 736                     LocalLibPath LexiconPath LocalLexiconPath PluginPath
 737                     LocalPluginPath MasonComponentRoot MasonLocalComponentRoot
 738                     MasonDataDir MasonSessionDir/
 739                      )
 740         {
 741             no strict 'refs';
 742
 743             # just change relative ones
 744             $$path = File::Spec->catfile( $BasePath, $$path )
 745                 unless File::Spec->file_name_is_absolute($$path);
 746         }
 747     }
 748
 749 }
 750
 751 =head2 AddJavaScript
 752
 753 helper method to add js files to C<JSFiles> config.
 754 to add extra js files, you can add the following line
 755 in the plugin's main file:
 756
 757     RT->AddJavaScript( 'foo.js', 'bar.js' );
 758
 759 =cut
 760
 761 sub AddJavaScript {
 762     my $self = shift;
 763
 764     my @old = RT->Config->Get('JSFiles');
 765     RT->Config->Set( 'JSFiles', @old, @_ );
 766     return RT->Config->Get('JSFiles');
 767 }
 768
 769 =head2 AddStyleSheets
 770
 771 helper method to add css files to C<CSSFiles> config
 772
 773 to add extra css files, you can add the following line
 774 in the plugin's main file:
 775
 776     RT->AddStyleSheets( 'foo.css', 'bar.css' );
 777
 778 =cut
 779
 780 sub AddStyleSheets {
 781     my $self = shift;
 782     my @old = RT->Config->Get('CSSFiles');
 783     RT->Config->Set( 'CSSFiles', @old, @_ );
 784     return RT->Config->Get('CSSFiles');
 785 }
 786
 787 =head2 JavaScript
 788
 789 helper method of RT->Config->Get('JSFiles')
 790
 791 =cut
 792
 793 sub JavaScript {
 794     return RT->Config->Get('JSFiles');
 795 }
 796
 797 =head2 StyleSheets
 798
 799 helper method of RT->Config->Get('CSSFiles')
 800
 801 =cut
 802
 803 sub StyleSheets {
 804     return RT->Config->Get('CSSFiles');
 805 }
 806
 807 =head1 BUGS
 808
 809 Please report them to rt-bugs@bestpractical.com, if you know what's
 810 broken and have at least some idea of what needs to be fixed.
 811
 812 If you're not sure what's going on, report them rt-devel@lists.bestpractical.com.
 813
 814 =head1 SEE ALSO
 815
 816 L<RT::StyleGuide>
 817 L<DBIx::SearchBuilder>
 818
 819 =cut
 820
 821 require RT::Base;
 822 RT::Base->_ImportOverlays();
 823
 824 1;