rt/share/html/Elements/ColumnMap

   1 %# BEGIN BPS TAGGED BLOCK {{{
   2 %#
   3 %# COPYRIGHT:
   4 %#
   5 %# This software is Copyright (c) 1996-2015 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 <%ARGS>
  49 $Class => 'RT__Ticket'
  50 $Name
  51 $Attr  => undef
  52 </%ARGS>
  53 <%ONCE>
  54
  55 # This is scary and should totally be refactored -- jesse
  56 my $COLUMN_MAP = {
  57     id => {
  58         attribute => 'id',
  59         title    => 'id', # loc
  60         align     => 'right',
  61         value     => sub { return $_[0]->id }
  62     },
  63
  64     Created => {
  65         attribute => 'Created',
  66         title     => 'Created', # loc
  67         value     => sub { return $_[0]->CreatedObj },
  68     },
  69     CreatedRelative => {
  70         attribute => 'Created',
  71         title     => 'Created', # loc
  72         value     => sub { return $_[0]->CreatedObj->AgeAsString }
  73     },
  74     CreatedBy => {
  75         attribute => 'Creator',
  76         title     => 'Created By', # loc
  77         value     => sub { return $_[0]->CreatorObj->Name }
  78     },
  79     LastUpdated => {
  80         attribute => 'LastUpdated',
  81         title     => 'Last Updated', # loc
  82         value     => sub { return $_[0]->LastUpdatedObj },
  83     },
  84     LastUpdatedRelative => {
  85         attribute => 'LastUpdated',
  86         title     => 'Last Updated', # loc
  87         value     => sub { return $_[0]->LastUpdatedObj->AgeAsString }
  88     },
  89     LastUpdatedBy => {
  90         attribute => 'LastUpdatedBy',
  91         title     => 'Last Updated By', # loc
  92         value     => sub { return $_[0]->LastUpdatedByObj->Name }
  93     },
  94
  95     CustomField => {
  96         attribute => sub { return shift @_ },
  97         title     => sub { return pop @_ },
  98         value     => sub {
  99             # Cache the CF object on a per-request basis, to avoid
 100             # having to load it for every row
 101             my $key = join("-","CF",
 102                            $_[0]->CustomFieldLookupType,
 103                            $_[0]->CustomFieldLookupId,
 104                            $_[-1]);
 105
 106             my $cf = $m->notes($key);
 107             unless ($cf) {
 108                 $cf = $_[0]->LoadCustomFieldByIdentifier($_[-1]);
 109                 $m->notes($key, $cf);
 110             }
 111
 112             # Display custom field contents, separated by newlines.
 113             # For Image custom fields we also show a thumbnail here.
 114             my $values = $cf->ValuesForObject( $_[0] );
 115             return if $values->Count == 0;
 116
 117             my @values;
 118             # it is guaranteed to be the same type for all fields, right?
 119             my $v = $values->First;
 120             my $cftype = $v->CustomFieldObj->Type;
 121
 122             do {
 123                 if ($cftype eq 'Image') {
 124                     push @values,
 125                         \($m->scomp( '/Elements/ShowCustomFieldImage',
 126                                       Object => $v ));
 127                 } elsif ( $cftype eq 'Date' or $cftype eq 'DateTime' ) {
 128                     # then actually return the date object;
 129                     # ProcessColumnMapValue will stringify it
 130                     my $DateObj = RT::Date->new( $session{'CurrentUser'} );
 131                     $DateObj->Set(Format => 'unknown', Value => $v->Content);
 132                     push @values, $DateObj;
 133                 } else {
 134                     push @values, $v->Content;
 135                 }
 136                 push @values, \'<br />'; # this is deeply silly
 137             } while ($v = $values->Next);
 138             pop @values; # Remove that last <br />
 139             return @values;
 140         },
 141     },
 142
 143     CheckBox => {
 144         title => sub {
 145             my $name = $_[1] || 'SelectedTickets';
 146             my $checked = $DECODED_ARGS->{ $name .'All' }? 'checked="checked"': '';
 147
 148             return \qq{<input type="checkbox" name="}, $name, \qq{All" value="1" $checked
 149                               onclick="setCheckbox(this.form, },
 150                               $m->interp->apply_escapes($name,'j'),
 151                               \qq{, this.checked)" />};
 152         },
 153         value => sub {
 154             my $id = $_[0]->id;
 155
 156             my $name = $_[2] || 'SelectedTickets';
 157             return \qq{<input type="checkbox" name="}, $name, \qq{" value="$id" checked="checked" />}
 158                 if $DECODED_ARGS->{ $name . 'All'};
 159
 160             my $arg = $DECODED_ARGS->{ $name };
 161             my $checked = '';
 162             if ( $arg && ref $arg ) {
 163                 $checked = 'checked="checked"' if grep $_ == $id, grep { defined and length } @$arg;
 164             }
 165             elsif ( $arg ) {
 166                 $checked = 'checked="checked"' if $arg == $id;
 167             }
 168             return \qq{<input type="checkbox" name="}, $name, \qq{" value="$id" $checked />}
 169         },
 170     },
 171     RadioButton => {
 172         title => \'&nbsp;',
 173         value => sub {
 174             my $id = $_[0]->id;
 175
 176             my $name = $_[2] || 'SelectedTicket';
 177             my $arg = $DECODED_ARGS->{ $name };
 178             my $checked = '';
 179             $checked = 'checked="checked"' if $arg && $arg == $id;
 180             return \qq{<input type="radio" name="}, $name, \qq{" value="$id" $checked />};
 181         },
 182     },
 183     (map {
 184         my $value = RT->Config->Get($_);
 185         $_ => { value => sub { return \$value } };
 186
 187     } qw(WebPath WebBaseURL WebURL)),
 188     WebRequestPath    => { value => sub { substr( $m->request_path, 1 ) } },
 189     WebRequestPathDir => { value => sub { substr( $m->request_comp->dir_path, 1 ) } },
 190 };
 191
 192 $COLUMN_MAP->{'CF'} = $COLUMN_MAP->{'CustomField'};
 193
 194 </%ONCE>
 195 <%INIT>
 196 $m->callback( COLUMN_MAP => $COLUMN_MAP, CallbackName => 'Once', CallbackOnce => 1 );
 197 $m->callback( COLUMN_MAP => $COLUMN_MAP );
 198
 199 # first deal with class specific things
 200 if (RT::Interface::Web->ComponentPathIsSafe($Class) and $m->comp_exists("/Elements/$Class/ColumnMap")) {
 201     my $class_map = $m->comp("/Elements/$Class/ColumnMap", Attr => $Attr, Name => $Name );
 202     return $class_map if defined $class_map;
 203 }
 204 return GetColumnMapEntry( Map => $COLUMN_MAP, Name => $Name, Attribute => $Attr );
 205
 206 </%INIT>