+sub Description {
+ my $self = shift;
+
+ unless ( $self->CurrentUserCanSee ) {
+ return ( $self->loc("Permission Denied") );
+ }
+
+ unless ( defined $self->Type ) {
+ return ( $self->loc("No transaction type specified"));
+ }
+
+ return $self->loc("[_1] by [_2]", $self->BriefDescription , $self->CreatorObj->Name );
+}
+
+
+
+=head2 BriefDescription
+
+Returns a text string which briefly describes this transaction
+
+=cut
+
+{
+ my $scrubber = HTML::Scrubber->new(default => 0); # deny everything
+
+ sub BriefDescription {
+ my $self = shift;
+ my $desc = $self->BriefDescriptionAsHTML;
+ $desc = $scrubber->scrub($desc);
+ $desc = HTML::Entities::decode_entities($desc);
+ return $desc;
+ }
+}
+
+=head2 BriefDescriptionAsHTML
+
+Returns an HTML string which briefly describes this transaction.
+
+=cut
+
+sub BriefDescriptionAsHTML {
+ my $self = shift;
+
+ unless ( $self->CurrentUserCanSee ) {
+ return ( $self->loc("Permission Denied") );
+ }
+
+ my ($objecttype, $type, $field) = ($self->ObjectType, $self->Type, $self->Field);
+
+ unless ( defined $type ) {
+ return $self->loc("No transaction type specified");
+ }
+
+ my ($template, @params);
+
+ my @code = grep { ref eq 'CODE' } map { $_BriefDescriptions{$_} }
+ ( $field
+ ? ("$objecttype-$type-$field", "$type-$field")
+ : () ),
+ "$objecttype-$type", $type;
+
+ if (@code) {
+ ($template, @params) = $code[0]->($self);
+ }
+
+ unless ($template) {
+ ($template, @params) = (
+ "Default: [_1]/[_2] changed from [_3] to [_4]", #loc
+ $type,
+ $field,
+ (
+ $self->OldValue
+ ? "'" . $self->OldValue . "'"
+ : $self->loc("(no value)")
+ ),
+ (
+ $self->NewValue
+ ? "'" . $self->NewValue . "'"
+ : $self->loc("(no value)")
+ ),
+ );
+ }
+ return $self->loc($template, $self->_ProcessReturnValues(@params));
+}
+
+sub _ProcessReturnValues {
+ my $self = shift;
+ my @values = @_;
+ return map {
+ if (ref eq 'ARRAY') { $_ = join "", $self->_ProcessReturnValues(@$_) }
+ elsif (ref eq 'SCALAR') { $_ = $$_ }
+ else { RT::Interface::Web::EscapeHTML(\$_) }
+ $_
+ } @values;
+}
+
+sub _FormatPrincipal {
+ my $self = shift;
+ my $principal = shift;
+ if ($principal->IsUser) {
+ return $self->_FormatUser( $principal->Object );
+ } else {
+ return $self->loc("group [_1]", $principal->Object->Name);
+ }
+}
+
+sub _FormatUser {
+ my $self = shift;
+ my $user = shift;
+ return [
+ \'<span class="user" data-replace="user" data-user-id="', $user->id, \'">',
+ $user->Format,
+ \'</span>'
+ ];
+}
+
+%_BriefDescriptions = (
+ Create => sub {
+ my $self = shift;
+ return ( "[_1] created", $self->FriendlyObjectType ); #loc()
+ },
+ Enabled => sub {
+ my $self = shift;
+ return ( "[_1] enabled", $self->FriendlyObjectType ); #loc()
+ },
+ Disabled => sub {
+ my $self = shift;
+ return ( "[_1] disabled", $self->FriendlyObjectType ); #loc()
+ },
+ Status => sub {
+ my $self = shift;
+ if ( $self->Field eq 'Status' ) {
+ if ( $self->NewValue eq 'deleted' ) {
+ return ( "[_1] deleted", $self->FriendlyObjectType ); #loc()
+ }
+ else {
+ my $canon = $self->Object->DOES("RT::Record::Role::Status")
+ ? sub { $self->Object->LifecycleObj->CanonicalCase(@_) }
+ : sub { return $_[0] };
+ return (
+ "Status changed from [_1] to [_2]",
+ "'" . $self->loc( $canon->($self->OldValue) ) . "'",
+ "'" . $self->loc( $canon->($self->NewValue) ) . "'"
+ ); # loc()
+ }
+ }
+
+ # Generic:
+ my $no_value = $self->loc("(no value)");
+ return (
+ "[_1] changed from [_2] to [_3]",
+ $self->Field,
+ ( $self->OldValue ? "'" . $self->OldValue . "'" : $no_value ),
+ "'" . $self->NewValue . "'"
+ ); #loc()
+ },
+ SystemError => sub {
+ my $self = shift;
+ return $self->Data // ("System error"); #loc()
+ },
+ AttachmentTruncate => sub {
+ my $self = shift;
+ if ( defined $self->Data ) {
+ return ( "File '[_1]' truncated because its size ([_2] bytes) exceeded configured maximum size setting ([_3] bytes).",
+ $self->Data, $self->OldValue, $self->NewValue ); #loc()
+ }
+ else {
+ return ( "Content truncated because its size ([_1] bytes) exceeded configured maximum size setting ([_2] bytes).",
+ $self->OldValue, $self->NewValue ); #loc()
+ }
+ },
+ AttachmentDrop => sub {
+ my $self = shift;
+ if ( defined $self->Data ) {
+ return ( "File '[_1]' dropped because its size ([_2] bytes) exceeded configured maximum size setting ([_3] bytes).",
+ $self->Data, $self->OldValue, $self->NewValue ); #loc()
+ }
+ else {
+ return ( "Content dropped because its size ([_1] bytes) exceeded configured maximum size setting ([_2] bytes).",
+ $self->OldValue, $self->NewValue ); #loc()
+ }
+ },
+ AttachmentError => sub {
+ my $self = shift;
+ if ( defined $self->Data ) {
+ return ( "File '[_1]' insert failed. See error log for details.", $self->Data ); #loc()
+ }
+ else {
+ return ( "Content insert failed. See error log for details." ); #loc()
+ }
+ },
+ "Forward Transaction" => sub {
+ my $self = shift;
+ my $recipients = join ", ", map {
+ RT::User->Format( Address => $_, CurrentUser => $self->CurrentUser )
+ } RT::EmailParser->ParseEmailAddress($self->Data);
+
+ return ( "Forwarded [_3]Transaction #[_1][_4] to [_2]",
+ $self->Field, $recipients,
+ [\'<a href="#txn-', $self->Field, \'">'], \'</a>'); #loc()
+ },
+ "Forward Ticket" => sub {
+ my $self = shift;
+ my $recipients = join ", ", map {
+ RT::User->Format( Address => $_, CurrentUser => $self->CurrentUser )
+ } RT::EmailParser->ParseEmailAddress($self->Data);
+
+ return ( "Forwarded Ticket to [_1]", $recipients ); #loc()
+ },
+ CommentEmailRecord => sub {
+ my $self = shift;
+ return ("Outgoing email about a comment recorded"); #loc()
+ },
+ EmailRecord => sub {
+ my $self = shift;
+ return ("Outgoing email recorded"); #loc()
+ },
+ Correspond => sub {
+ my $self = shift;
+ return ("Correspondence added"); #loc()
+ },
+ Comment => sub {
+ my $self = shift;
+ return ("Comments added"); #loc()
+ },
+ CustomField => sub {
+ my $self = shift;
+ my $field = $self->loc('CustomField');
+
+ my $cf;
+ if ( $self->Field ) {
+ $cf = RT::CustomField->new( $self->CurrentUser );
+ $cf->SetContextObject( $self->Object );
+ $cf->Load( $self->Field );
+ $field = $cf->Name();
+ $field = $self->loc('a custom field') if !defined($field);
+ }
+
+ my $new = $self->NewValue;
+ my $old = $self->OldValue;
+
+ if ( $cf ) {
+
+ if ( $cf->Type eq 'DateTime' ) {
+ if ($old) {
+ my $date = RT::Date->new( $self->CurrentUser );
+ $date->Set( Format => 'ISO', Value => $old );
+ $old = $date->AsString;
+ }
+
+ if ($new) {
+ my $date = RT::Date->new( $self->CurrentUser );
+ $date->Set( Format => 'ISO', Value => $new );
+ $new = $date->AsString;
+ }
+ }
+ elsif ( $cf->Type eq 'Date' ) {
+ if ($old) {
+ my $date = RT::Date->new( $self->CurrentUser );
+ $date->Set(
+ Format => 'unknown',
+ Value => $old,
+ Timezone => 'UTC',
+ );
+ $old = $date->AsString( Time => 0, Timezone => 'UTC' );
+ }
+
+ if ($new) {
+ my $date = RT::Date->new( $self->CurrentUser );
+ $date->Set(
+ Format => 'unknown',
+ Value => $new,
+ Timezone => 'UTC',
+ );
+ $new = $date->AsString( Time => 0, Timezone => 'UTC' );
+ }
+ }
+ }
+
+ if ( !defined($old) || $old eq '' ) {
+ return ("[_1] [_2] added", $field, $new); #loc()
+ }
+ elsif ( !defined($new) || $new eq '' ) {
+ return ("[_1] [_2] deleted", $field, $old); #loc()
+ }
+ else {
+ return ("[_1] [_2] changed to [_3]", $field, $old, $new); #loc()
+ }
+ },
+ Untake => sub {
+ my $self = shift;
+ return ("Untaken"); #loc()
+ },
+ Take => sub {
+ my $self = shift;
+ return ("Taken"); #loc()
+ },
+ Force => sub {
+ my $self = shift;
+ my $Old = RT::User->new( $self->CurrentUser );
+ $Old->Load( $self->OldValue );
+ my $New = RT::User->new( $self->CurrentUser );
+ $New->Load( $self->NewValue );
+
+ return ("Owner forcibly changed from [_1] to [_2]",
+ map { $self->_FormatUser($_) } $Old, $New); #loc()
+ },
+ Steal => sub {
+ my $self = shift;
+ my $Old = RT::User->new( $self->CurrentUser );
+ $Old->Load( $self->OldValue );
+ return ("Stolen from [_1]", $self->_FormatUser($Old)); #loc()
+ },
+ Give => sub {
+ my $self = shift;
+ my $New = RT::User->new( $self->CurrentUser );
+ $New->Load( $self->NewValue );
+ return ( "Given to [_1]", $self->_FormatUser($New)); #loc()
+ },
+ AddWatcher => sub {
+ my $self = shift;
+ my $principal = RT::Principal->new($self->CurrentUser);
+ $principal->Load($self->NewValue);
+ return ( "[_1] [_2] added", $self->loc($self->Field), $self->_FormatPrincipal($principal)); #loc()
+ },
+ DelWatcher => sub {
+ my $self = shift;
+ my $principal = RT::Principal->new($self->CurrentUser);
+ $principal->Load($self->OldValue);
+ return ( "[_1] [_2] deleted", $self->loc($self->Field), $self->_FormatPrincipal($principal)); #loc()
+ },
+ SetWatcher => sub {
+ my $self = shift;
+ my $principal = RT::Principal->new($self->CurrentUser);
+ $principal->Load($self->NewValue);
+ return ( "[_1] set to [_2]", $self->loc($self->Field), $self->_FormatPrincipal($principal)); #loc()
+ },
+ Subject => sub {
+ my $self = shift;
+ return ( "Subject changed to [_1]", $self->Data ); #loc()
+ },
+ AddLink => sub {
+ my $self = shift;
+ my $value;
+ if ( $self->NewValue ) {
+ my $URI = RT::URI->new( $self->CurrentUser );
+ if ( $URI->FromURI( $self->NewValue ) ) {
+ $value = [
+ \'<a href="', $URI->AsHREF, \'">',
+ $URI->AsString,
+ \'</a>'
+ ];
+ }
+ else {
+ $value = $self->NewValue;
+ }
+
+ if ( $self->Field eq 'DependsOn' ) {
+ return ( "Dependency on [_1] added", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'DependedOnBy' ) {
+ return ( "Dependency by [_1] added", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'RefersTo' ) {
+ return ( "Reference to [_1] added", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'ReferredToBy' ) {
+ return ( "Reference by [_1] added", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'MemberOf' ) {
+ return ( "Membership in [_1] added", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'HasMember' ) {
+ return ( "Member [_1] added", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'MergedInto' ) {
+ return ( "Merged into [_1]", $value ); #loc()
+ }
+ }
+ else {
+ return ( "[_1]", $self->Data ); #loc()
+ }
+ },
+ DeleteLink => sub {
+ my $self = shift;
+ my $value;
+ if ( $self->OldValue ) {
+ my $URI = RT::URI->new( $self->CurrentUser );
+ if ( $URI->FromURI( $self->OldValue ) ) {
+ $value = [
+ \'<a href="', $URI->AsHREF, \'">',
+ $URI->AsString,
+ \'</a>'
+ ];
+ }
+ else {
+ $value = $self->OldValue;
+ }
+
+ if ( $self->Field eq 'DependsOn' ) {
+ return ( "Dependency on [_1] deleted", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'DependedOnBy' ) {
+ return ( "Dependency by [_1] deleted", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'RefersTo' ) {
+ return ( "Reference to [_1] deleted", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'ReferredToBy' ) {
+ return ( "Reference by [_1] deleted", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'MemberOf' ) {
+ return ( "Membership in [_1] deleted", $value ); #loc()
+ }
+ elsif ( $self->Field eq 'HasMember' ) {
+ return ( "Member [_1] deleted", $value ); #loc()
+ }
+ }
+ else {
+ return ( "[_1]", $self->Data ); #loc()
+ }
+ },
+ Told => sub {
+ my $self = shift;
+ if ( $self->Field eq 'Told' ) {
+ my $t1 = RT::Date->new($self->CurrentUser);
+ $t1->Set(Format => 'ISO', Value => $self->NewValue);
+ my $t2 = RT::Date->new($self->CurrentUser);
+ $t2->Set(Format => 'ISO', Value => $self->OldValue);
+ return ( "[_1] changed from [_2] to [_3]", $self->loc($self->Field), $t2->AsString, $t1->AsString ); #loc()
+ }
+ else {
+ return ( "[_1] changed from [_2] to [_3]",
+ $self->loc($self->Field),
+ ($self->OldValue? "'".$self->OldValue ."'" : $self->loc("(no value)")) , "'". $self->NewValue."'" ); #loc()
+ }
+ },
+ Set => sub {
+ my $self = shift;
+ if ( $self->Field eq 'Password' ) {
+ return ('Password changed'); #loc()
+ }
+ elsif ( $self->Field eq 'Queue' ) {
+ my $q1 = RT::Queue->new( $self->CurrentUser );
+ $q1->Load( $self->OldValue );
+ my $q2 = RT::Queue->new( $self->CurrentUser );
+ $q2->Load( $self->NewValue );
+ return ("[_1] changed from [_2] to [_3]",
+ $self->loc($self->Field) , $q1->Name , $q2->Name); #loc()
+ }
+
+ # Write the date/time change at local time:
+ elsif ($self->Field =~ /Due|Starts|Started|Told|WillResolve/) {
+ my $t1 = RT::Date->new($self->CurrentUser);
+ $t1->Set(Format => 'ISO', Value => $self->NewValue);
+ my $t2 = RT::Date->new($self->CurrentUser);
+ $t2->Set(Format => 'ISO', Value => $self->OldValue);
+ return ( "[_1] changed from [_2] to [_3]", $self->loc($self->Field), $t2->AsString, $t1->AsString ); #loc()
+ }
+ elsif ( $self->Field eq 'Owner' ) {
+ my $Old = RT::User->new( $self->CurrentUser );
+ $Old->Load( $self->OldValue );
+ my $New = RT::User->new( $self->CurrentUser );
+ $New->Load( $self->NewValue );
+
+ if ( $Old->id == RT->Nobody->id ) {
+ if ( $New->id == $self->Creator ) {
+ return ("Taken"); #loc()
+ }
+ else {
+ return ( "Given to [_1]", $self->_FormatUser($New) ); #loc()
+ }
+ }
+ else {
+ if ( $New->id == $self->Creator ) {
+ return ("Stolen from [_1]", $self->_FormatUser($Old) ); #loc()
+ }
+ elsif ( $Old->id == $self->Creator ) {
+ if ( $New->id == RT->Nobody->id ) {
+ return ("Untaken"); #loc()
+ }
+ else {
+ return ( "Given to [_1]", $self->_FormatUser($New) ); #loc()
+ }
+ }
+ else {
+ return (
+ "Owner forcibly changed from [_1] to [_2]",
+ map { $self->_FormatUser($_) } $Old, $New
+ ); #loc()
+ }
+ }
+ }
+ else {
+ return ( "[_1] changed from [_2] to [_3]",
+ $self->loc($self->Field),
+ ($self->OldValue? "'".$self->OldValue ."'" : $self->loc("(no value)")),
+ ($self->NewValue? "'".$self->NewValue ."'" : $self->loc("(no value)"))); #loc()
+ }
+ },
+ "Set-TimeWorked" => sub {
+ my $self = shift;
+ my $old = $self->OldValue || 0;
+ my $new = $self->NewValue || 0;
+ my $duration = $new - $old;
+ if ($duration < 0) {
+ return ("Adjusted time worked by [quant,_1,minute,minutes]", $duration); # loc()
+ }
+ elsif ($duration < 60) {
+ return ("Worked [quant,_1,minute,minutes]", $duration); # loc()
+ } else {
+ return ("Worked [quant,_1,hour,hours] ([quant,_2,minute,minutes])", sprintf("%.1f", $duration / 60), $duration); # loc()
+ }
+ },
+ PurgeTransaction => sub {
+ my $self = shift;
+ return ("Transaction [_1] purged", $self->Data); #loc()
+ },
+ AddReminder => sub {
+ my $self = shift;
+ my $ticket = RT::Ticket->new($self->CurrentUser);
+ $ticket->Load($self->NewValue);
+ my $subject = [
+ \'<a href="', RT->Config->Get('WebPath'),
+ "/Ticket/Reminders.html?id=", $self->ObjectId,
+ "#reminder-", $ticket->id, \'">', $ticket->Subject, \'</a>'
+ ];
+ return ("Reminder '[_1]' added", $subject); #loc()
+ },
+ OpenReminder => sub {
+ my $self = shift;
+ my $ticket = RT::Ticket->new($self->CurrentUser);
+ $ticket->Load($self->NewValue);
+ my $subject = [
+ \'<a href="', RT->Config->Get('WebPath'),
+ "/Ticket/Reminders.html?id=", $self->ObjectId,
+ "#reminder-", $ticket->id, \'">', $ticket->Subject, \'</a>'
+ ];
+ return ("Reminder '[_1]' reopened", $subject); #loc()
+ },
+ ResolveReminder => sub {
+ my $self = shift;
+ my $ticket = RT::Ticket->new($self->CurrentUser);
+ $ticket->Load($self->NewValue);
+ my $subject = [
+ \'<a href="', RT->Config->Get('WebPath'),
+ "/Ticket/Reminders.html?id=", $self->ObjectId,
+ "#reminder-", $ticket->id, \'">', $ticket->Subject, \'</a>'
+ ];
+ return ("Reminder '[_1]' completed", $subject); #loc()
+ }
+);
+
+
+
+
+=head2 IsInbound
+
+Returns true if the creator of the transaction is a requestor of the ticket.
+Returns false otherwise
+
+=cut
+
+sub IsInbound {
+ my $self = shift;
+ $self->ObjectType eq 'RT::Ticket' or return undef;
+ return ( $self->TicketObj->IsRequestor( $self->CreatorObj->PrincipalId ) );
+}
+
+
+
+sub _OverlayAccessible {
+ {
+
+ ObjectType => { public => 1},
+ ObjectId => { public => 1},
+
+ }
+};
+
+
+
+
+sub _Set {
+ my $self = shift;
+ return ( 0, $self->loc('Transactions are immutable') );
+}
+
+
+
+=head2 _Value
+
+Takes the name of a table column.
+Returns its value as a string, if the user passes an ACL check
+
+=cut
+
+sub _Value {
+ my $self = shift;
+ my $field = shift;
+
+ #if the field is public, return it.
+ if ( $self->_Accessible( $field, 'public' ) ) {
+ return $self->SUPER::_Value( $field );
+ }
+
+ unless ( $self->CurrentUserCanSee ) {
+ return undef;
+ }
+
+ return $self->SUPER::_Value( $field );
+}
+
+
+=head2 CurrentUserCanSee
+
+Returns true if current user has rights to see this particular transaction.
+
+This fact depends on type of the transaction, type of an object the transaction
+is attached to and may be other conditions, so this method is prefered over
+custom implementations.
+
+It always returns true if current user is system user.
+
+=cut
+
+sub CurrentUserCanSee {
+ my $self = shift;
+
+ return 1 if $self->CurrentUser->PrincipalObj->Id == RT->SystemUser->Id;
+
+ # Make sure the user can see the custom field before showing that it changed
+ my $type = $self->__Value('Type');
+ if ( $type eq 'CustomField' and my $cf_id = $self->__Value('Field') ) {
+ my $cf = RT::CustomField->new( $self->CurrentUser );
+ $cf->SetContextObject( $self->Object );
+ $cf->Load( $cf_id );
+ return 0 unless $cf->CurrentUserHasRight('SeeCustomField');
+ }
+
+ # Transactions that might have changed the ->Object's visibility to
+ # the current user are marked readable
+ return 1 if $self->{ _object_is_readable };
+
+ # Defer to the object in question
+ return $self->Object->CurrentUserCanSee("Transaction", $self);
+}
+
+
+sub Ticket {
+ my $self = shift;
+ return $self->ObjectId;
+}
+