rt/share/html/Helpers/Autocomplete/Users

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2017 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 => ''
  53 $term => undef
  54 $delim => undef
  55 $max => undef
  56 $privileged => undef
  57 $exclude => ''
  58 $op => undef
  59 </%ARGS>
  60 <%INIT>
  61 # Only allow certain return fields
  62 $return = 'EmailAddress'
  63     unless $return =~ /^(?:EmailAddress|Name|RealName)$/;
  64
  65 $m->abort unless defined $return
  66              and defined $term
  67              and length $term;
  68
  69 # Use our delimeter if we have one
  70 if ( defined $delim and length $delim ) {
  71     if ( $delim eq ',' ) {
  72         $delim = qr/,\s*/;
  73     } else {
  74         $delim = qr/\Q$delim\E/;
  75     }
  76
  77     # If the field handles multiple values, pop the last one off
  78     $term = (split $delim, $term)[-1] if $term =~ $delim;
  79 }
  80
  81 my $CurrentUser = $session{'CurrentUser'};
  82
  83 # Require privileged users or overriding config
  84 $m->abort unless $CurrentUser->Privileged
  85               or RT->Config->Get('AllowUserAutocompleteForUnprivileged');
  86
  87 # the API wants a list of ids
  88 my @exclude = split /\s*,\s*/, $exclude;
  89 push @exclude, RT->SystemUser->id, RT->Nobody->id;
  90
  91 $m->callback( CallbackName => 'ModifyMaxResults', max => \$max );
  92 $max //= 10;
  93
  94 my $users = RT::Users->new($CurrentUser);
  95 $users->SimpleSearch( Privileged => $privileged,
  96                       Return     => $return,
  97                       Term       => $term,
  98                       Max        => $max,
  99                       Exclude    => \@exclude,
 100                       # If an operator is provided, check against only
 101                       # the returned field using that operator
 102                       $op ? ( Fields => { $return => $op } ) : (),
 103                     );
 104
 105 my @suggestions;
 106 while ( my $user = $users->Next ) {
 107     my $suggestion = { id => $user->id, label => $user->Format, value => $user->$return };
 108     $m->callback( CallbackName => "ModifySuggestion", suggestion => $suggestion, user => $user );
 109     push @suggestions, $suggestion;
 110 }
 111
 112 </%INIT>