[Rt-commit] r2607 - rt/branches/3.4-RELEASE/lib/RT
tla at bestpractical.com
tla at bestpractical.com
Mon Apr 11 14:47:04 EDT 2005
Author: tla
Date: Mon Apr 11 14:47:03 2005
New Revision: 2607
Added:
rt/branches/3.4-RELEASE/lib/RT/SavedSearches.pm
Modified:
rt/branches/3.4-RELEASE/lib/RT/SavedSearch.pm
Log:
Semi-tested, semi-working checkpoint. Formal tests to follow shortly.
Modified: rt/branches/3.4-RELEASE/lib/RT/SavedSearch.pm
==============================================================================
--- rt/branches/3.4-RELEASE/lib/RT/SavedSearch.pm (original)
+++ rt/branches/3.4-RELEASE/lib/RT/SavedSearch.pm Mon Apr 11 14:47:03 2005
@@ -49,7 +49,7 @@
=head1 SYNOPSIS
- use RT::Date
+ use RT::SavedSearch
=head1 DESCRIPTION
@@ -75,17 +75,16 @@
my $proto = shift;
my $class = ref($proto) || $proto;
my $self = {};
+ $self->{'Id'} = 0;
bless ($self, $class);
$self->CurrentUser(@_);
- $self->{'Id'} = 0;
return $self;
}
=head2 Load
-Takes an object type, which must be either 'RT::User' or 'RT::Group',
-an object ID, and a search ID. Loads the given search ID if it belongs
-to the stated user or group.
+Takes a privacy specification, an object ID, and a search ID. Loads
+the given search ID if it belongs to the stated user or group.
=begin testing
@@ -97,43 +96,85 @@
sub Load {
my $self = shift;
- my ($obj_type, $obj_id, $id) = @_;
- my $object = $self->_GetObject($obj_type, $obj_id);
+ my ($privacy, $id) = @_;
+ my $object = $self->_GetObject($privacy);
if ($object) {
$self->{'Attribute'} = $object->Attributes->WithId($id);
- $self->{'Id'} = $self->{'Attribute'}->Id();
+ $self->{'Id'} = $self->{'Attribute'}->Id;
+ $self->{'Privacy'} = $privacy;
+ $self->{'Type'} = $self->{'Attribute'}->SubValue('SearchType');
+ use Data::Dumper;
+ print Dumper($self);
+ } else {
+ $RT::Logger->error("Could not find object $privacy when loading search");
}
}
+=head2 Save
+
+Takes a privacy, an optional type, a name, and a hash containing the
+search parameters. Saves the given parameters to the appropriate user/
+group object, and loads the resulting search.
+
+=cut
+
sub Save {
my $self = shift;
- my ($obj_type, $obj_id, $description, %params) = @_;
- my $object = $self->_GetObject($obj_type, $obj_id);
+ my ($privacy, $type, $name, %params) = @_;
- # Save the info.
- if ($object->Id == $obj_id) {
- my ($att_id, $att_msg) = $object->AddAttribute(
- 'Name' => 'SavedSearch',
- 'Description' => $description,
- 'Content' => \%params);
- if ($att_id) {
- $self->{'Attribute'} = $object->Attributes->WithId($att_id);
- $self->{'Id'} = $att_id;
- } else {
- $RT::Logger->warning("SavedSearch save failure: $att_msg");
+ unless($privacy || $name) {
+ # Save to the current object.
+ unless($self->{'Attribute'}) {
+ $RT::Logger->error("Tried to save to a nonexistent search without specifying a privacy!");
+ return;
+ }
+ my ($ret, $msg) = $self->_UpdateContent(%params);
+ unless($ret) {
+ $RT::Logger->error("Could not update content of search "
+ . $self->Id . ": $msg");
+ }
+ } else {
+ $params{'SearchType'} = $type;
+ my $object = $self->_GetObject($privacy);
+ if ($object->Id) {
+ my ($att_id, $att_msg) = $object->AddAttribute(
+ 'Name' => 'SavedSearch',
+ 'Description' => $name,
+ 'Content' => \%params);
+ if ($att_id) {
+ $self->{'Attribute'} = $object->Attributes->WithId($att_id);
+ $self->{'Id'} = $att_id;
+ $self->{'Privacy'} = $privacy;
+ $self->{'Type'} = $type;
+ } else {
+ $RT::Logger->error("SavedSearch save failure: $att_msg");
+ }
+ }
}
}
### Accessor methods
-sub Description {
+=head2 Name
+
+Returns the name of the search.
+
+=cut
+
+sub Name {
my $self = shift;
return unless ref($self->{'Attribute'}) eq 'RT::Attribute';
return $self->{'Attribute'}->Description();
}
+=head2 GetParameter
+
+Returns the given named parameter of the search, e.g. 'Query', 'Format'.
+
+=cut
+
sub GetParameter {
my $self = shift;
my $param = shift;
@@ -141,19 +182,53 @@
return $self->{'Attribute'}->SubValue($param);
}
+=head2 Id
+
+Returns the numerical id of this search.
+
+=cut
+
sub Id {
+ my $self = shift;
+ return $self->{'Id'};
+}
+
+=head2 Privacy
+
+Returns the principal object to whom this search belongs, in a string
+"<class>-<id>", e.g. "RT::Group-16".
+
+=cut
+
+sub Privacy {
my $self = shift;
- return $self->{'Id'};
+ return $self->{'Privacy'};
}
-### _GetObject: helper routine to load the correct object whose parameters
-### have been passed.
+=head2 Type
+
+Returns the type of this search, e.g. 'Ticket'. Useful for denoting the
+saved searches that are relevant to a particular search page.
+
+=cut
+
+sub Type {
+ my $self = shift;
+ return $self->{'Type'};
+}
+
+### Internal methods
+
+# _GetObject: helper routine to load the correct object whose parameters
+# have been passed.
sub _GetObject {
my $self = shift;
- my ($obj_type, $obj_id) = @_;
+ my $privacy = shift;
+
+ my ($obj_type, $obj_id) = split(/\-/, $privacy);
unless ($obj_type eq 'RT::User' || $obj_type eq 'RT::Group') {
- $RT::Logger->warning("Tried to load a search belonging to $obj_type $obj_id, which is neither a user nor a group");
+ $RT::Logger->error("Tried to load a search belonging to an $obj_type, which is neither a user nor a group");
return undef;
}
@@ -161,9 +236,10 @@
eval "
require $obj_type;
\$object = $obj_type->new(\$self->CurrentUser);
+ \$object->Load(\$obj_id);
";
unless (ref($object) eq $obj_type) {
- $RT::Logger->warning("Could not load object of type $obj_type with ID $obj_id");
+ $RT::Logger->error("Could not load object of type $obj_type with ID $obj_id");
return undef;
}
@@ -172,16 +248,26 @@
if ($obj_type eq 'RT::User') {
return undef
- unless $object->Id == $self->{'CurrentUser'}->UserObj->Id();
+ unless $object->Id == $self->CurrentUser->UserObj->Id();
}
if ($obj_type eq 'RT::Group') {
- return undef
- unless $object->HasMember($self->{'CurrentUser'}->PrincipalObj);
+ return undef unless
+ $object->HasMemberRecursively($self->CurrentUser->PrincipalObj);
}
return $object;
}
+# _UpdateContent: Change the parameters of an existing saved search.
+
+sub _UpdateContent {
+ my $self = shift;
+ my %params = shift;
+
+ my ($status, $msg) = $self->{'Attribute'}->SetSubValues(%params);
+ return ($status, $msg);
+}
+
eval "require RT::SavedSearch_Vendor";
die $@ if ($@ && $@ !~ qr{^Can't locate RT/SavedSearch_Vendor.pm});
eval "require RT::SavedSearch_Local";
Added: rt/branches/3.4-RELEASE/lib/RT/SavedSearches.pm
==============================================================================
--- (empty file)
+++ rt/branches/3.4-RELEASE/lib/RT/SavedSearches.pm Mon Apr 11 14:47:03 2005
@@ -0,0 +1,203 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC
+# <jesse at 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+#
+# 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::SavedSearches - a pseudo-collection for SavedSearch objects.
+
+=head1 SYNOPSIS
+
+ use RT::SavedSearch
+
+=head1 DESCRIPTION
+
+ SavedSearches is an object consisting of a number of SavedSearch objects.
+ It works more or less like a DBIx::SearchBuilder collection, although it
+ is not.
+
+=head1 METHODS
+
+=cut
+
+
+package RT::SavedSearches;
+
+use RT::Base;
+use RT::SavedSearch;
+
+use strict;
+use vars qw/@ISA/;
+ at ISA = qw/RT::Base/;
+
+sub new {
+ my $proto = shift;
+ my $class = ref($proto) || $proto;
+ my $self = {};
+ bless ($self, $class);
+ $self->CurrentUser(@_);
+ $self->{'idx'} = 0;
+ $self->{'objects'} = [];
+ return $self;
+}
+
+=head2 LimitToPrivacy
+
+Takes two argumets: a privacy string, of the format "<class>-<id>", as
+produced by RT::SavedSearch::Privacy(); and a type string, as produced
+by RT::SavedSearch::Type(). The SavedSearches object will load the
+searches belonging to that user or group that are of the type
+specified. If no type is specified, all the searches belonging to the
+user/group will be loaded.
+
+=begin testing
+
+use_ok(RT::SavedSearches);
+
+=end testing
+
+=cut
+
+sub Limit {
+ my $self = shift;
+ my $privacy = shift;
+ my $type = shift;
+
+ my $object = $self->_GetObject($privacy);
+
+ if ($object) {
+ my @search_atts = $object->Attributes->Named('SavedSearch');
+ foreach my $att (@search_atts) {
+ my $search = RT::SavedSearch->new($self->CurrentUser);
+ $search->Load($privacy, $att->Id);
+ next if $type && $search->Type ne $type;
+ push(@{$self->{'objects'}}, $search);
+ }
+ } else {
+ $RT::Logger->error("Could not load object $privacy");
+ }
+}
+
+### Accessor methods
+
+=head2 Next
+
+Returns the next object in the collection.
+
+=cut
+
+sub Next {
+ my $self = shift;
+ my $search = $self->{'objects'}->[$self->{'idx'}];
+ if ($search) {
+ $self->{'idx'}++;
+ } else {
+ # We have run out of objects; reset the counter.
+ $self->{'idx'} = 0;
+ }
+ return $search;
+}
+
+=head2 Count
+
+Returns the number of search objects found.
+
+=cut
+
+sub Count {
+ my $self = shift;
+ return scalar @{$self->{'objects'}};
+}
+
+### Internal methods
+
+# _GetObject: helper routine to load the correct object whose parameters
+# have been passed.
+
+sub _GetObject {
+ my $self = shift;
+ my $privacy = shift;
+
+ my ($obj_type, $obj_id) = split(/\-/, $privacy);
+ unless ($obj_type eq 'RT::User' || $obj_type eq 'RT::Group') {
+ $RT::Logger->error("Tried to load a search belonging to an $obj_type, which is neither a user nor a group");
+ return undef;
+ }
+
+ my $object;
+ eval "
+ require $obj_type;
+ \$object = $obj_type->new(\$self->CurrentUser);
+ \$object->Load($obj_id);
+ ";
+ unless (ref($object) eq $obj_type) {
+ $RT::Logger->error("Could not load object of type $obj_type with ID $obj_id");
+ return undef;
+ }
+
+ # Do not allow the loading of a user object other than the current
+ # user, or of a group object of which the current user is not a member.
+
+ if ($obj_type eq 'RT::User'
+ && $object->Id != $self->CurrentUser->UserObj->Id()) {
+ $RT::Logger->error('Requested user ' . $object->Id
+ . 'is not current user');
+ return undef;
+ }
+ if ($obj_type eq 'RT::Group'
+ && !$object->HasMemberRecursively($self->CurrentUser->PrincipalObj)) {
+ $RT::Logger->error('Current user does not belong to requested group '
+ . $object->Id);
+ return undef;
+ }
+
+ return $object;
+}
+
+eval "require RT::SavedSearches_Vendor";
+die $@ if ($@ && $@ !~ qr{^Can't locate RT/SavedSearches_Vendor.pm});
+eval "require RT::SavedSearches_Local";
+die $@ if ($@ && $@ !~ qr{^Can't locate RT/SavedSearches_Local.pm});
+
+1;
More information about the Rt-commit
mailing list