Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / rt / lib / RT / SavedSearches.pm
index 262bfa8..c060701 100644 (file)
@@ -1,38 +1,40 @@
 # BEGIN BPS TAGGED BLOCK {{{
-# 
+#
 # COPYRIGHT:
-#  
-# This software is Copyright (c) 1996-2005 Best Practical Solutions, LLC 
-#                                          <jesse@bestpractical.com>
-# 
+#
+# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+#                                          <sales@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.
-# 
-# 
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+# 02110-1301 or visit their web page on the internet at
+# http://www.gnu.org/licenses/old-licenses/gpl-2.0.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
@@ -41,7 +43,7 @@
 # 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
@@ -50,7 +52,7 @@
 
 =head1 SYNOPSIS
 
-  use RT::SavedSearch
+  use RT::SavedSearches
 
 =head1 DESCRIPTION
 
 
 =head1 METHODS
 
-=begin testing
-
-use_ok(RT::SavedSearches);
-
-# The real tests are in lib/t/20savedsearch.t
-
-=end testing
 
 =cut
 
 package RT::SavedSearches;
 
-use RT::Base;
+use strict;
+use warnings;
+use base 'RT::SharedSettings';
+
 use RT::SavedSearch;
 
-use strict;
-use vars qw/@ISA/;
-@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;
+sub RecordClass {
+    return 'RT::SavedSearch';
 }
 
 =head2 LimitToPrivacy
@@ -109,98 +96,19 @@ sub LimitToPrivacy {
     my $object = $self->_GetObject($privacy);
 
     if ($object) {
-       $self->{'objects'} = [];
-       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'}++;
+        $self->{'objects'} = [];
+        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 && $search->Type ne $type;
+            push(@{$self->{'objects'}}, $search);
+        }
     } 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;
+        $RT::Logger->error("Could not load object $privacy");
     }
-
-    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});
+RT::Base->_ImportOverlays();
 
 1;