rt/lib/RT/Handle.pm

   1 # {{{ BEGIN BPS TAGGED BLOCK
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2004 Best Practical Solutions, LLC
   6 #                                          <jesse@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., 675 Mass Ave, Cambridge, MA 02139, USA.
  26 #
  27 #
  28 # CONTRIBUTION SUBMISSION POLICY:
  29 #
  30 # (The following paragraph is not intended to limit the rights granted
  31 # to you to modify and distribute this software under the terms of
  32 # the GNU General Public License and is only of importance to you if
  33 # you choose to contribute your changes and enhancements to the
  34 # community by submitting them to Best Practical Solutions, LLC.)
  35 #
  36 # By intentionally submitting any modifications, corrections or
  37 # derivatives to this work, or any other work intended for use with
  38 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  39 # you are the copyright holder for those contributions and you grant
  40 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  41 # royalty-free, perpetual, license to use, copy, create derivative
  42 # works based on those contributions, and sublicense and distribute
  43 # those contributions and any derivatives thereof.
  44 #
  45 # }}} END BPS TAGGED BLOCK
  46 =head1 NAME
  47
  48   RT::Handle - RT's database handle
  49
  50 =head1 SYNOPSIS
  51
  52   use RT::Handle;
  53
  54 =head1 DESCRIPTION
  55
  56 =begin testing
  57
  58 ok(require RT::Handle);
  59
  60 =end testing
  61
  62 =head1 METHODS
  63
  64 =cut
  65
  66 package RT::Handle;
  67
  68 use strict;
  69 use vars qw/@ISA/;
  70
  71 eval "use DBIx::SearchBuilder::Handle::$RT::DatabaseType;
  72 \@ISA= qw(DBIx::SearchBuilder::Handle::$RT::DatabaseType);";
  73
  74 if ($@) {
  75     die "Unable to load DBIx::SearchBuilder database handle for '$RT::DatabaseType'.".
  76         "\n".
  77         "Perhaps you've picked an invalid database type or spelled it incorrectly.".
  78         "\n". $@;
  79 }
  80
  81 =head2 Connect
  82
  83 Connects to RT's database handle.
  84 Takes nothing. Calls SUPER::Connect with the needed args
  85
  86 =cut
  87
  88 sub Connect {
  89     my $self = shift;
  90
  91     if ($RT::DatabaseType eq 'Oracle') {
  92         $ENV{'NLS_LANG'} = ".UTF8";
  93     }
  94
  95     $self->SUPER::Connect(
  96                          User => $RT::DatabaseUser,
  97                          Password => $RT::DatabasePassword,
  98                         );
  99
 100     $self->dbh->{LongReadLen} = $RT::MaxAttachmentSize;
 101
 102 }
 103
 104 =item BuildDSN
 105
 106 Build the DSN for the RT database. doesn't take any parameters, draws all that
 107 from the config file.
 108
 109 =cut
 110
 111
 112 sub BuildDSN {
 113     my $self = shift;
 114 # Unless the database port is a positive integer, we really don't want to pass it.
 115 $RT::DatabasePort = undef unless (defined $RT::DatabasePort && $RT::DatabasePort =~ /^(\d+)$/);
 116 $RT::DatabaseHost = undef unless (defined $RT::DatabaseHost && $RT::DatabaseHost ne '');
 117
 118
 119     $self->SUPER::BuildDSN(Host => $RT::DatabaseHost,
 120                          Database => $RT::DatabaseName,
 121                          Port => $RT::DatabasePort,
 122                          Driver => $RT::DatabaseType,
 123                          RequireSSL => $RT::DatabaseRequireSSL,
 124              DisconnectHandleOnDestroy => 1
 125                         );
 126
 127
 128 }
 129
 130 eval "require RT::Handle_Vendor";
 131 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Handle_Vendor.pm});
 132 eval "require RT::Handle_Local";
 133 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Handle_Local.pm});
 134
 135 1;