rt/lib/RT/Handle.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2005 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
  47 =head1 NAME
  48
  49   RT::Handle - RT's database handle
  50
  51 =head1 SYNOPSIS
  52
  53   use RT::Handle;
  54
  55 =head1 DESCRIPTION
  56
  57 =begin testing
  58
  59 ok(require RT::Handle);
  60
  61 =end testing
  62
  63 =head1 METHODS
  64
  65 =cut
  66
  67 package RT::Handle;
  68
  69 use strict;
  70 use vars qw/@ISA/;
  71
  72 eval "use DBIx::SearchBuilder::Handle::$RT::DatabaseType;
  73 \@ISA= qw(DBIx::SearchBuilder::Handle::$RT::DatabaseType);";
  74
  75 if ($@) {
  76     die "Unable to load DBIx::SearchBuilder database handle for '$RT::DatabaseType'.".
  77         "\n".
  78         "Perhaps you've picked an invalid database type or spelled it incorrectly.".
  79         "\n". $@;
  80 }
  81
  82 =head2 Connect
  83
  84 Connects to RT's database handle.
  85 Takes nothing. Calls SUPER::Connect with the needed args
  86
  87 =cut
  88
  89 sub Connect {
  90     my $self = shift;
  91
  92     if ($RT::DatabaseType eq 'Oracle') {
  93         $ENV{'NLS_LANG'} = "AMERICAN_AMERICA.AL32UTF8";
  94         $ENV{'NLS_NCHAR'} = "AL32UTF8";
  95
  96     }
  97
  98     $self->SUPER::Connect(
  99                          User => $RT::DatabaseUser,
 100                          Password => $RT::DatabasePassword,
 101                         );
 102
 103     $self->dbh->{LongReadLen} = $RT::MaxAttachmentSize;
 104
 105 }
 106
 107 =head2 BuildDSN
 108
 109 Build the DSN for the RT database. doesn't take any parameters, draws all that
 110 from the config file.
 111
 112 =cut
 113
 114 use File::Spec;
 115
 116 sub BuildDSN {
 117     my $self = shift;
 118 # Unless the database port is a positive integer, we really don't want to pass it.
 119 $RT::DatabasePort = undef unless (defined $RT::DatabasePort && $RT::DatabasePort =~ /^(\d+)$/);
 120 $RT::DatabaseHost = undef unless (defined $RT::DatabaseHost && $RT::DatabaseHost ne '');
 121 $RT::DatabaseName = File::Spec->catfile($RT::VarPath, $RT::DatabaseName)
 122     if ($RT::DatabaseType eq 'SQLite') and
 123         not File::Spec->file_name_is_absolute($RT::DatabaseName);
 124
 125
 126     $self->SUPER::BuildDSN(Host => $RT::DatabaseHost,
 127                          Database => $RT::DatabaseName,
 128                          Port => $RT::DatabasePort,
 129                          Driver => $RT::DatabaseType,
 130                          RequireSSL => $RT::DatabaseRequireSSL,
 131              DisconnectHandleOnDestroy => 1
 132                         );
 133
 134
 135 }
 136
 137 eval "require RT::Handle_Vendor";
 138 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Handle_Vendor.pm});
 139 eval "require RT::Handle_Local";
 140 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Handle_Local.pm});
 141
 142 1;