rt/lib/RT/SavedSearches.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
   6 #                                          <sales@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., 51 Franklin Street, Fifth Floor, Boston, MA
  26 # 02110-1301 or visit their web page on the internet at
  27 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
  28 #
  29 #
  30 # CONTRIBUTION SUBMISSION POLICY:
  31 #
  32 # (The following paragraph is not intended to limit the rights granted
  33 # to you to modify and distribute this software under the terms of
  34 # the GNU General Public License and is only of importance to you if
  35 # you choose to contribute your changes and enhancements to the
  36 # community by submitting them to Best Practical Solutions, LLC.)
  37 #
  38 # By intentionally submitting any modifications, corrections or
  39 # derivatives to this work, or any other work intended for use with
  40 # Request Tracker, to Best Practical Solutions, LLC, you confirm that
  41 # you are the copyright holder for those contributions and you grant
  42 # Best Practical Solutions,  LLC a nonexclusive, worldwide, irrevocable,
  43 # royalty-free, perpetual, license to use, copy, create derivative
  44 # works based on those contributions, and sublicense and distribute
  45 # those contributions and any derivatives thereof.
  46 #
  47 # END BPS TAGGED BLOCK }}}
  48
  49 =head1 NAME
  50
  51   RT::SavedSearches - a pseudo-collection for SavedSearch objects.
  52
  53 =head1 SYNOPSIS
  54
  55   use RT::SavedSearch
  56
  57 =head1 DESCRIPTION
  58
  59   SavedSearches is an object consisting of a number of SavedSearch objects.
  60   It works more or less like a DBIx::SearchBuilder collection, although it
  61   is not.
  62
  63 =head1 METHODS
  64
  65
  66 =cut
  67
  68 package RT::SavedSearches;
  69
  70 use RT::SavedSearch;
  71
  72 use strict;
  73 use base 'RT::Base';
  74
  75 sub new  {
  76     my $proto = shift;
  77     my $class = ref($proto) || $proto;
  78     my $self  = {};
  79     bless ($self, $class);
  80     $self->CurrentUser(@_);
  81     $self->{'idx'} = 0;
  82     $self->{'objects'} = [];
  83     return $self;
  84 }
  85
  86 =head2 LimitToPrivacy
  87
  88 Takes two argumets: a privacy string, of the format "<class>-<id>", as
  89 produced by RT::SavedSearch::Privacy(); and a type string, as produced
  90 by RT::SavedSearch::Type().  The SavedSearches object will load the
  91 searches belonging to that user or group that are of the type
  92 specified.  If no type is specified, all the searches belonging to the
  93 user/group will be loaded.  Repeated calls to the same object should DTRT.
  94
  95 =cut
  96
  97 sub LimitToPrivacy {
  98     my $self = shift;
  99     my $privacy = shift;
 100     my $type = shift;
 101
 102     my $object = $self->_GetObject($privacy);
 103
 104     if ($object) {
 105         $self->{'objects'} = [];
 106         my @search_atts = $object->Attributes->Named('SavedSearch');
 107         foreach my $att (@search_atts) {
 108             my $search = RT::SavedSearch->new($self->CurrentUser);
 109             $search->Load($privacy, $att->Id);
 110             next if $type && $search->Type ne $type;
 111             push(@{$self->{'objects'}}, $search);
 112         }
 113     } else {
 114         $RT::Logger->error("Could not load object $privacy");
 115     }
 116 }
 117
 118 ### Accessor methods
 119
 120 =head2 Next
 121
 122 Returns the next object in the collection.
 123
 124 =cut
 125
 126 sub Next {
 127     my $self = shift;
 128     my $search = $self->{'objects'}->[$self->{'idx'}];
 129     if ($search) {
 130         $self->{'idx'}++;
 131     } else {
 132         # We have run out of objects; reset the counter.
 133         $self->{'idx'} = 0;
 134     }
 135     return $search;
 136 }
 137
 138 =head2 Count
 139
 140 Returns the number of search objects found.
 141
 142 =cut
 143
 144 sub Count {
 145     my $self = shift;
 146     return scalar @{$self->{'objects'}};
 147 }
 148
 149 ### Internal methods
 150
 151 # _GetObject: helper routine to load the correct object whose parameters
 152 #  have been passed.
 153
 154 sub _GetObject {
 155     my $self = shift;
 156     my $privacy = shift;
 157
 158     return RT::SavedSearch->new($self->CurrentUser)->_GetObject($privacy);
 159 }
 160
 161 ### Internal methods
 162
 163 # _PrivacyObjects: returns a list of objects that can be used to load saved searches from.
 164
 165 sub _PrivacyObjects {
 166     my $self        = shift;
 167     my $CurrentUser = $self->CurrentUser;
 168
 169     my $groups = RT::Groups->new($CurrentUser);
 170     $groups->LimitToUserDefinedGroups;
 171     $groups->WithMember( PrincipalId => $CurrentUser->Id,
 172                          Recursively => 1 );
 173
 174     return ( $CurrentUser->UserObj, @{ $groups->ItemsArrayRef() } );
 175 }
 176
 177 RT::Base->_ImportOverlays();
 178
 179 1;