diff options
Diffstat (limited to 'rt/lib/RT/Search')
| -rw-r--r-- | rt/lib/RT/Search/ActiveTicketsInQueue.pm | 102 | ||||
| -rw-r--r-- | rt/lib/RT/Search/FromSQL.pm | 110 | ||||
| -rw-r--r-- | rt/lib/RT/Search/Generic.pm | 152 | ||||
| -rw-r--r-- | rt/lib/RT/Search/Googleish.pm | 188 |
4 files changed, 552 insertions, 0 deletions
diff --git a/rt/lib/RT/Search/ActiveTicketsInQueue.pm b/rt/lib/RT/Search/ActiveTicketsInQueue.pm new file mode 100644 index 000000000..d75cd1f2c --- /dev/null +++ b/rt/lib/RT/Search/ActiveTicketsInQueue.pm @@ -0,0 +1,102 @@ +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC +# <jesse@bestpractical.com> +# +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: +# +# This work is made available to you under the terms of Version 2 of +# the GNU General Public License. A copy of that license should have +# been provided with this software, but in any event can be snarfed +# from www.gnu.org. +# +# This work is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/copyleft/gpl.html. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) +# +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. +# +# END BPS TAGGED BLOCK }}} +=head1 NAME + + RT::Search::ActiveTicketsInQueue + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +Find all active tickets in the queue named in the argument passed in + +=head1 METHODS + + +=begin testing + +ok (require RT::Search::Generic); + +=end testing + + +=cut + +package RT::Search::ActiveTicketsInQueue; + +use strict; +use base qw(RT::Search::Generic); + + +# {{{ sub Describe +sub Describe { + my $self = shift; + return ($self->loc("No description for [_1]", ref $self)); +} +# }}} + +# {{{ sub Prepare +sub Prepare { + my $self = shift; + + $self->TicketsObj->LimitQueue(VALUE => $self->Argument); + + foreach my $status (RT::Queue->ActiveStatusArray()) { + $self->TicketsObj->LimitStatus(VALUE => $status); + } + + return(1); +} +# }}} + +eval "require RT::Search::ActiveTicketsInQueue_Vendor"; +die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/ActiveTicketsInQueue_Vendor.pm}); +eval "require RT::Search::ActiveTicketsInQueue_Local"; +die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/ActiveTicketsInQueue_Local.pm}); + +1; diff --git a/rt/lib/RT/Search/FromSQL.pm b/rt/lib/RT/Search/FromSQL.pm new file mode 100644 index 000000000..e3a126416 --- /dev/null +++ b/rt/lib/RT/Search/FromSQL.pm @@ -0,0 +1,110 @@ +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC +# <jesse@bestpractical.com> +# +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: +# +# This work is made available to you under the terms of Version 2 of +# the GNU General Public License. A copy of that license should have +# been provided with this software, but in any event can be snarfed +# from www.gnu.org. +# +# This work is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/copyleft/gpl.html. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) +# +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. +# +# END BPS TAGGED BLOCK }}} +=head1 NAME + + RT::Search::FromSQL + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +Find all tickets described by the SQL statement passed as an argument + +=head1 METHODS + + +=begin testing + +ok (require RT::Search::Generic); + +=end testing + + +=cut + +package RT::Search::FromSQL; + +use strict; +use base qw(RT::Search::Generic); + +=head2 Describe + +Returns a localized string describing the module's function. + +=cut + +# {{{ sub Describe +sub Describe { + my $self = shift; + return ($self->loc("TicketSQL search module", ref $self)); +} +# }}} + +=head2 Prepare + +The meat of the module. Runs a search on its Tickets object, using +the SQL string described in its Argument object. The Tickets object +is reduced to those tickets matching the SQL query. + +=cut + +# {{{ sub Prepare +sub Prepare { + my $self = shift; + + $self->TicketsObj->FromSQL($self->Argument); + return(1); +} +# }}} + +eval "require RT::Search::FromSQL_Vendor"; +die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/FromSQL_Vendor.pm}); +eval "require RT::Search::FromSQL_Local"; +die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/FromSQL_Local.pm}); + +1; diff --git a/rt/lib/RT/Search/Generic.pm b/rt/lib/RT/Search/Generic.pm new file mode 100644 index 000000000..15e5e9630 --- /dev/null +++ b/rt/lib/RT/Search/Generic.pm @@ -0,0 +1,152 @@ +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC +# <jesse@bestpractical.com> +# +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: +# +# This work is made available to you under the terms of Version 2 of +# the GNU General Public License. A copy of that license should have +# been provided with this software, but in any event can be snarfed +# from www.gnu.org. +# +# This work is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/copyleft/gpl.html. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) +# +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. +# +# END BPS TAGGED BLOCK }}} +=head1 NAME + + RT::Search::Generic - ; + +=head1 SYNOPSIS + + use RT::Search::Generic; + my $tickets = RT::Tickets->new($CurrentUser); + my $foo = RT::Search::Generic->new(Argument => $arg, + TicketsObj => $tickets); + $foo->Prepare(); + while ( my $ticket = $foo->Next ) { + # Do something with each ticket we've found + } + + +=head1 DESCRIPTION + + +=head1 METHODS + + +=begin testing + +ok (require RT::Search::Generic); + +=end testing + + +=cut + +package RT::Search::Generic; + +use strict; + +# {{{ sub new +sub new { + my $proto = shift; + my $class = ref($proto) || $proto; + my $self = {}; + bless ($self, $class); + $self->_Init(@_); + return $self; +} +# }}} + +# {{{ sub _Init +sub _Init { + my $self = shift; + my %args = ( + TicketsObj => undef, + Argument => undef, + @_ ); + + $self->{'TicketsObj'} = $args{'TicketsObj'}; + $self->{'Argument'} = $args{'Argument'}; +} +# }}} + +# {{{ sub Argument + +=head2 Argument + +Return the optional argument associated with this Search + +=cut + +sub Argument { + my $self = shift; + return($self->{'Argument'}); +} +# }}} + + +=head2 TicketsObj + +Return the Tickets object passed into this search + +=cut + +sub TicketsObj { + my $self = shift; + return($self->{'TicketsObj'}); +} + +# {{{ sub Describe +sub Describe { + my $self = shift; + return ($self->loc("No description for [_1]", ref $self)); +} +# }}} + +# {{{ sub Prepare +sub Prepare { + my $self = shift; + return(1); +} +# }}} + +eval "require RT::Search::Generic_Vendor"; +die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Generic_Vendor.pm}); +eval "require RT::Search::Generic_Local"; +die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Generic_Local.pm}); + +1; diff --git a/rt/lib/RT/Search/Googleish.pm b/rt/lib/RT/Search/Googleish.pm new file mode 100644 index 000000000..a2a887377 --- /dev/null +++ b/rt/lib/RT/Search/Googleish.pm @@ -0,0 +1,188 @@ + +# BEGIN BPS TAGGED BLOCK {{{ +# +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC +# <jesse@bestpractical.com> +# +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: +# +# This work is made available to you under the terms of Version 2 of +# the GNU General Public License. A copy of that license should have +# been provided with this software, but in any event can be snarfed +# from www.gnu.org. +# +# This work is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/copyleft/gpl.html. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) +# +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. +# +# END BPS TAGGED BLOCK }}} +=head1 NAME + + RT::Search::Googlish + +=head1 SYNOPSIS + +=head1 DESCRIPTION + +Use the argument passed in as a "Google-style" set of keywords + +=head1 METHODS + + +=begin testing + +ok (require RT::Search::Generic); + +=end testing + + +=cut + +package RT::Search::Googleish; + +use strict; +use base qw(RT::Search::Generic); + + +# sub _Init {{{ +sub _Init { + my $self = shift; + my %args = @_; + + $self->{'Queues'} = delete($args{'Queues'}) || []; + $self->SUPER::_Init(%args); +} +# }}} + +# {{{ sub Describe +sub Describe { + my $self = shift; + return ($self->loc("No description for [_1]", ref $self)); +} +# }}} + +# {{{ sub QueryToSQL +sub QueryToSQL { + my $self = shift; + my $query = shift || $self->Argument; + my @keywords = split /\s+/, $query; + my ( + @tql_clauses, @owner_clauses, @queue_clauses, + @user_clauses, @id_clauses, @status_clauses + ); + my ( $Queue, $User ); + for my $key (@keywords) { + + # Is this a ticket number? If so, go to it. + if ( $key =~ m/^\d+$/ ) { + push @id_clauses, "id = '$key'"; + } + + elsif ( $key =~ /\w+\@\w+/ ) { + push @user_clauses, "Requestor LIKE '$key'"; + } + + # Is there a status with this name? + elsif ( + $Queue = RT::Queue->new( $self->TicketsObj->CurrentUser ) + and $Queue->IsValidStatus($key) + ) + { + push @status_clauses, "Status = '" . $key . "'"; + } + + # Is there a owner named $key? + # Is there a queue named $key? + elsif ( $Queue = RT::Queue->new( $self->TicketsObj->CurrentUser ) + and $Queue->Load($key) ) + { + push @queue_clauses, "Queue = '" . $Queue->Name . "'"; + } + + # Is there a owner named $key? + elsif ( $User = RT::User->new( $self->TicketsObj->CurrentUser ) + and $User->Load($key) + and $User->Privileged ) + { + push @owner_clauses, "Owner = '" . $User->Name . "'"; + } + + elsif ($key =~ /^fulltext:(.*?)$/i) { + $key = $1; + $key =~ s/['\\].*//g; + push @tql_clauses, "Content LIKE '$key'"; + + } + + # Else, subject must contain $key + else { + $key =~ s/['\\].*//g; + push @tql_clauses, "Subject LIKE '$key'"; + } + } + + # restrict to any queues requested by the caller + for my $queue (@{ $self->{'Queues'} }) { + my $QueueObj = RT::Queue->new($self->TicketsObj->CurrentUser); + $QueueObj->Load($queue) or next; + push @queue_clauses, "Queue = '" . $QueueObj->Name . "'"; + } + + push @tql_clauses, join( " OR ", sort @id_clauses ); + push @tql_clauses, join( " OR ", sort @owner_clauses ); + push @tql_clauses, join( " OR ", sort @status_clauses ); + push @tql_clauses, join( " OR ", sort @user_clauses ); + push @tql_clauses, join( " OR ", sort @queue_clauses ); + @tql_clauses = grep { $_ ? $_ = "( $_ )" : undef } @tql_clauses; + return join " AND ", sort @tql_clauses; +} +# }}} + +# {{{ sub Prepare +sub Prepare { + my $self = shift; + my $tql = $self->QueryToSQL($self->Argument); + + $RT::Logger->crit($tql); + + $self->TicketsObj->FromSQL($tql); + return(1); +} +# }}} + +eval "require RT::Search::Googleish_Vendor"; +die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Googleish_Vendor.pm}); +eval "require RT::Search::Googleish_Local"; +die $@ if ($@ && $@ !~ qr{^Can't locate RT/Search/Googleish_Local.pm}); + +1; |