Master to 4.2.8
[usit-rt.git] / share / html / Helpers / Autocomplete / Owners
1 %# BEGIN BPS TAGGED BLOCK {{{
2 %#
3 %# COPYRIGHT:
4 %#
5 %# This software is Copyright (c) 1996-2014 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 % $r->content_type('application/json; charset=utf-8');
49 <% JSON( \@suggestions ) |n %>
50 % $m->abort;
51 <%ARGS>
52 $return => 'Name'
53 $limit => undef
54 $term => undef
55 $max => undef
56 </%ARGS>
57 <%INIT>
58 # Only allow certain return fields
59 $return = 'Name'
60     unless $return =~ /^(?:EmailAddress|Name|RealName|id)$/;
61
62 $m->abort unless defined $return
63              and defined $term
64              and defined $limit;
65
66 my $CurrentUser = $session{'CurrentUser'};
67
68 my %user_uniq_hash;
69 my $isSU = $session{CurrentUser}
70     ->HasRight( Right => 'SuperUser', Object => $RT::System );
71
72 $m->callback( CallbackName => 'ModifyMaxResults', max => \$max );
73 $max //= 10;
74
75 # Turn RT::Ticket-1|RT::Queue-2 into ['RT::Ticket', 1], ['RT::Queue', 2]
76 foreach my $spec (map { [split /\-/, $_, 2] } split /\|/, $limit) {
77     next unless $spec->[0] =~ /^RT::(Ticket|Queue)$/;
78
79     my $object = $spec->[0]->new( $session{'CurrentUser'} );
80
81     if ( $spec->[1] ) {
82         $object->Load( $spec->[1] );
83
84         # Warn if we couldn't load an object
85         unless ( $object->id ) {
86             $RT::Logger->warn("Owner autocomplete couldn't load an '$spec->[0]' with id '$spec->[1]'");
87             next;
88         }
89     }
90
91     my $Users = RT::Users->new( $session{CurrentUser} );
92     # Limit by our autocomplete term BEFORE we limit to OwnTicket because that
93     # does a funky union hack
94     $Users->SimpleSearch(
95         Max    => $max,
96         Term   => $term,
97         Return => $return,
98     );
99
100     $Users->WhoHaveRight(
101         Right               => 'OwnTicket',
102         Object              => $object,
103         IncludeSystemRights => 1,
104         IncludeSuperusers   => $isSU
105     );
106
107     while ( my $User = $Users->Next() ) {
108         next if $user_uniq_hash{ $User->Id };
109         $user_uniq_hash{ $User->Id() } = [
110             $User,
111             $User->Format,
112         ];
113     }
114 }
115
116 # Make sure we add Nobody if we don't already have it
117 my $nobody = qr/^n(?:o(?:b(?:o(?:d(?:y)?)?)?)?)?$/i;
118 if ( not $user_uniq_hash{RT->Nobody->id} and $term =~ $nobody ) {
119     $user_uniq_hash{RT->Nobody->id} = [
120         RT->Nobody,
121         RT->Nobody->Format,
122     ];
123 }
124
125 my @users = sort { lc $a->[1] cmp lc $b->[1] }
126                  values %user_uniq_hash;
127
128 my @suggestions;
129 my $count = 1;
130
131 for my $tuple ( @users ) {
132     last if $count > $max;
133     my $formatted = $tuple->[1];
134     $formatted =~ s/\n//g;
135     push @suggestions, {
136         label => $formatted,
137         value => $tuple->[0]->$return
138     };
139     $count++;
140 }
141 </%INIT>