rt/lib/RT/Search/FromSQL.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 # BEGIN LICENSE BLOCK
  47 #
  48 # Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
  49 #
  50 # (Except where explictly superceded by other copyright notices)
  51 #
  52 # This work is made available to you under the terms of Version 2 of
  53 # the GNU General Public License. A copy of that license should have
  54 # been provided with this software, but in any event can be snarfed
  55 # from www.gnu.org.
  56 #
  57 # This work is distributed in the hope that it will be useful, but
  58 # WITHOUT ANY WARRANTY; without even the implied warranty of
  59 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  60 # General Public License for more details.
  61 #
  62 # Unless otherwise specified, all modifications, corrections or
  63 # extensions to this work which alter its source code become the
  64 # property of Best Practical Solutions, LLC when submitted for
  65 # inclusion in the work.
  66 #
  67 #
  68 # END LICENSE BLOCK
  69 =head1 NAME
  70
  71   RT::Search::FromSQL
  72
  73 =head1 SYNOPSIS
  74
  75 =head1 DESCRIPTION
  76
  77 Find all tickets described by the SQL statement passed as an argument
  78
  79 =head1 METHODS
  80
  81
  82 =begin testing
  83
  84 ok (require RT::Search::Generic);
  85
  86 =end testing
  87
  88
  89 =cut
  90
  91 package RT::Search::FromSQL;
  92
  93 use strict;
  94 use base qw(RT::Search::Generic);
  95
  96 =head2 Describe
  97
  98 Returns a localized string describing the module's function.
  99
 100 =cut
 101
 102 # {{{ sub Describe
 103 sub Describe  {
 104     my $self = shift;
 105     return ($self->loc("TicketSQL search module", ref $self));
 106 }
 107 # }}}
 108
 109 =head2 Prepare
 110
 111 The meat of the module.  Runs a search on its Tickets object, using
 112 the SQL string described in its Argument object.  The Tickets object
 113 is reduced to those tickets matching the SQL query.
 114
 115 =cut
 116
 117 # {{{ sub Prepare
 118 sub Prepare  {
 119     my $self = shift;
 120
 121     $self->TicketsObj->FromSQL($self->Argument);
 122     return(1);
 123 }
 124 # }}}
 125
 126 eval "require RT::Search::FromSQL_Vendor";
 127 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/FromSQL_Vendor.pm});
 128 eval "require RT::Search::FromSQL_Local";
 129 die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/FromSQL_Local.pm});
 130
 131 1;