rt/share/html/Elements/SelectObject

   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 % if ($Lite) {
  49 %     my $d = $ObjectType->new($session{'CurrentUser'});
  50 %     $d->Load($Default);
  51 <input name="<%$Name%>" size="25" value="<%$d->Name%>" class="<%$Class%>" />
  52 % }
  53 % else {
  54 <select name="<%$Name%>" <% ($Multiple) ? qq{multiple="multiple" size="$Size"} : '' |n%> <% ($OnChange) ? 'onchange="'.$OnChange.'"' : '' |n %> class="<%$Class%>">
  55 %     if ($ShowNullOption) {
  56   <option value=""><% $DefaultLabel %></option>
  57 %     }
  58 %     for my $object (@{$session{$cache_key}{objects}}) {
  59   <option value="<% ($NamedValues ? $object->{Name} : $object->{Id}) %>"\
  60 % if ($object->{Id} eq ($Default||'') || $object->{Name} eq ($Default||'')) {
  61  selected="selected"\
  62 % }
  63 ><%$object->{Name}%>\
  64 %             if ($Verbose and $object->{Description}) {
  65  (<%$object->{Description}%>)\
  66 %             }
  67 </option>
  68 %     }
  69 </select>
  70 % }
  71 <%args>
  72 $ObjectType
  73 $CheckRight => undef
  74 $ShowNullOption => 1
  75 $ShowAll => 1
  76 $Name => undef
  77 $Verbose => undef
  78 $NamedValues => 0
  79 $DefaultLabel => "-"
  80 $Default => 0
  81 $Lite => 0
  82 $OnChange => undef
  83 $Multiple => 0
  84 $Size => 6
  85 $Class => ""
  86 $CacheNeedsUpdate => undef
  87 </%args>
  88 <%init>
  89 $ObjectType = "RT::$ObjectType" unless $ObjectType =~ /::/;
  90 $Class    ||= "select-" . CSSClass("\L$1") if $ObjectType =~ /RT::(.+)$/;
  91
  92 my $cache_key = join "---", "SelectObject", $ObjectType,
  93     $session{'CurrentUser'}->Id, $CheckRight || "", $ShowAll;
  94
  95 if ( defined $session{$cache_key} && ref $session{$cache_key} eq 'ARRAY') {
  96     delete $session{$cache_key};
  97 }
  98 if ( defined $session{$cache_key} && defined $CacheNeedsUpdate &&
  99      $session{$cache_key}{lastupdated} <= $CacheNeedsUpdate ) {
 100     delete $session{$cache_key};
 101 }
 102
 103 if ( not defined $session{$cache_key} and not $Lite ) {
 104     my $collection = "${ObjectType}s"->new($session{'CurrentUser'});
 105     $collection->UnLimit;
 106
 107     $m->callback( CallbackName => 'ModifyCollection', ARGSRef => \%ARGS,
 108                   Collection => $collection, ObjectType => $ObjectType );
 109
 110     if ( $Default ) {
 111         my $object = $ObjectType->new($session{'CurrentUser'});
 112         $object->Load( $Default );
 113         unless ( $ShowAll
 114                  or not $CheckRight
 115                  or $session{CurrentUser}->HasRight( Object => $object, Right => $CheckRight ) )
 116         {
 117             if ( $object->id ) {
 118                 push @{$session{$cache_key}{objects}}, {
 119                     Id          => $object->id,
 120                     Name        => '#' . $object->id,
 121                     Description => '#' . $object->id,
 122                 };
 123             }
 124         }
 125     }
 126
 127     while (my $object = $collection->Next) {
 128         if ($ShowAll
 129             or not $CheckRight
 130             or $session{CurrentUser}->HasRight( Object => $object, Right => $CheckRight ))
 131         {
 132             push @{$session{$cache_key}{objects}}, {
 133                 Id          => $object->Id,
 134                 Name        => $object->Name,
 135                 Description => $object->_Accessible("Description" => "read") ? $object->Description : undef,
 136             };
 137         }
 138     }
 139     $session{$cache_key}{lastupdated} = time();
 140 }
 141 </%init>