rt/lib/RT/Plugin.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2019 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::Plugin;
  53 use File::ShareDir;
  54
  55 =head1 NAME
  56
  57 RT::Plugin
  58
  59 =head1 METHODS
  60
  61 =head2 new
  62
  63 Instantiate a new L<RT::Plugin> object. Takes a paramhash. currently the only key
  64 it cares about is 'name', the name of this plugin.
  65
  66 =cut
  67
  68 sub new {
  69     my $class = shift;
  70     my $args ={@_};
  71     my $self = bless $args, $class;
  72     return $self;
  73 }
  74
  75
  76 =head2 Name
  77
  78 Returns a human-readable name for this plugin.
  79
  80 =cut
  81
  82 sub Name {
  83     my $self = shift;
  84     return $self->{name};
  85 }
  86
  87 =head2 Version
  88
  89 Returns the extension version.
  90
  91 =cut
  92
  93 sub Version {
  94     my $self = shift;
  95     no strict 'refs';
  96     return ${$self->Name . '::VERSION'};
  97 }
  98
  99 =head2 Path
 100
 101 Takes a name of sub directory and returns its full path, for example:
 102
 103     my $plugin_etc_dir = $plugin->Path('etc');
 104
 105 See also L</ComponentRoot>, L</StaticDir>, L</PoDir> and other shortcut methods.
 106
 107 =cut
 108
 109 sub Path {
 110     my $self   = shift;
 111     my $subdir = shift;
 112     my $res = $self->_BasePath;
 113     $res .= "/$subdir" if defined $subdir && length $subdir;
 114     return $res;
 115 }
 116
 117 sub _BasePath {
 118     my $self = shift;
 119     my $base = $self->{'name'};
 120     $base =~ s/::/-/g;
 121     my $local_base = $RT::LocalPluginPath."/".$base;
 122     my $base_base = $RT::PluginPath."/".$base;
 123
 124     return -d $local_base ? $local_base : $base_base;
 125 }
 126
 127 =head2 ComponentRoot
 128
 129 Returns the directory this plugin has installed its L<HTML::Mason> templates into
 130
 131 =cut
 132
 133 sub ComponentRoot { return $_[0]->Path('html') }
 134
 135 =head2 StaticDir
 136
 137 Returns the directory this plugin has installed its static files into
 138
 139 =cut
 140
 141 sub StaticDir { return $_[0]->Path('static') }
 142
 143 =head2 PoDir
 144
 145 Returns the directory this plugin has installed its message catalogs into.
 146
 147 =cut
 148
 149 sub PoDir { return $_[0]->Path('po') }
 150
 151 RT::Base->_ImportOverlays();
 152
 153 1;