rt/share/html/Helpers/Autocomplete/CustomFieldValues

   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 <%INIT>
  52 # Only autocomplete the last value
  53 my $term = (split /\n/, $ARGS{term} || '')[-1];
  54
  55 my $abort = sub {
  56     $r->content_type('application/json; charset=utf-8');
  57     $m->out(JSON( [] ));
  58     $m->abort;
  59 };
  60
  61 unless ( exists $ARGS{ContextType} and exists $ARGS{ContextId} ) {
  62     RT->Logger->debug("No context provided");
  63     $abort->();
  64 }
  65
  66 # Use _ParseObjectCustomFieldArgs to avoid duplicating the regex.
  67 # See the docs for _ParseObjectCustomFieldArgs for details on the data
  68 # structure returned. There will be only one CF, so drill down 2 layers
  69 # to get the cf id, if one is there.
  70
  71 my %custom_fields = _ParseObjectCustomFieldArgs(\%ARGS, IncludeBulkUpdate => 1);
  72 my $CustomField;
  73 foreach my $class ( keys %custom_fields ){
  74     foreach my $id ( keys %{$custom_fields{$class}} ){
  75         ($CustomField) = keys %{$custom_fields{$class}{$id}};
  76     }
  77 }
  78
  79 unless ( $CustomField ) {
  80     RT->Logger->debug("No CustomField provided");
  81     $abort->();
  82 }
  83
  84 my $SystemCustomFieldObj = RT::CustomField->new( RT->SystemUser );
  85 my ($id, $msg) = $SystemCustomFieldObj->LoadById( $CustomField ) ;
  86 unless ( $id ) {
  87     RT->Logger->debug("Invalid CustomField provided: $msg");
  88     $abort->();
  89 }
  90
  91 my $context_object = $SystemCustomFieldObj->LoadContextObject(
  92     $ARGS{ContextType}, $ARGS{ContextId} );
  93 $abort->() unless $context_object;
  94
  95 my $CustomFieldObj = RT::CustomField->new( $session{'CurrentUser'} );
  96 if ( $SystemCustomFieldObj->ValidateContextObject($context_object) ) {
  97     # drop our privileges that came from calling LoadContextObject as the System User
  98     $context_object->new($session{'CurrentUser'});
  99     $context_object->LoadById($ARGS{ContextId});
 100     $CustomFieldObj->SetContextObject( $context_object );
 101 } else {
 102     RT->Logger->debug("Invalid Context Object ".$context_object->id." for Custom Field ".$SystemCustomFieldObj->id);
 103     $abort->();
 104 }
 105
 106 ($id, $msg) = $CustomFieldObj->LoadById( $CustomField );
 107 unless ( $CustomFieldObj->Name ) {
 108     RT->Logger->debug("Current User cannot see this Custom Field, terminating");
 109     $abort->();
 110 }
 111
 112 my $values = $CustomFieldObj->Values;
 113 $values->Limit(
 114     FIELD           => 'Name',
 115     OPERATOR        => 'LIKE',
 116     VALUE           => $term,
 117     SUBCLAUSE       => 'autocomplete',
 118     CASESENSITIVE   => 0,
 119 );
 120 $values->Limit(
 121     ENTRYAGGREGATOR => 'OR',
 122     FIELD           => 'Description',
 123     OPERATOR        => 'LIKE',
 124     VALUE           => $term,
 125     SUBCLAUSE       => 'autocomplete',
 126     CASESENSITIVE   => 0,
 127 );
 128 $m->callback(
 129     CallbackName => 'ModifyMaxResults',
 130     max => \$ARGS{max},
 131     term => $term,
 132     CustomField => $CustomFieldObj,
 133 );
 134 $values->RowsPerPage( $ARGS{max} // 10 );
 135
 136 my @suggestions;
 137
 138 while( my $value = $values->Next ) {
 139     push @suggestions,
 140       {
 141         value => $value->Name,
 142         label => $value->Description
 143         ? $value->Name . ' (' . $value->Description . ')'
 144         : $value->Name,
 145       };
 146 }
 147 </%INIT>