X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Flib%2FRT%2FTransaction_Overlay.pm;h=451f9d732fc3cc38e4de414f24e0f0f1195ba10d;hb=3a17b276638200475d54201fa62566b7440e819a;hp=2e9d737b605ca65fa377b7c38b277429ac4b307e;hpb=c582e92888b4a5553e1b4e5214cf35217e4a0cf0;p=freeside.git diff --git a/rt/lib/RT/Transaction_Overlay.pm b/rt/lib/RT/Transaction_Overlay.pm index 2e9d737b6..451f9d732 100644 --- a/rt/lib/RT/Transaction_Overlay.pm +++ b/rt/lib/RT/Transaction_Overlay.pm @@ -1,8 +1,14 @@ -# BEGIN LICENSE BLOCK +# BEGIN BPS TAGGED BLOCK {{{ # -# Copyright (c) 1996-2003 Jesse Vincent +# COPYRIGHT: +# +# This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC +# # -# (Except where explictly superceded by other copyright notices) +# (Except where explicitly superseded by other copyright notices) +# +# +# LICENSE: # # This work is made available to you under the terms of Version 2 of # the GNU General Public License. A copy of that license should have @@ -14,13 +20,31 @@ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. # -# Unless otherwise specified, all modifications, corrections or -# extensions to this work which alter its source code become the -# property of Best Practical Solutions, LLC when submitted for -# inclusion in the work. +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301 or visit their web page on the internet at +# http://www.gnu.org/copyleft/gpl.html. +# +# +# CONTRIBUTION SUBMISSION POLICY: +# +# (The following paragraph is not intended to limit the rights granted +# to you to modify and distribute this software under the terms of +# the GNU General Public License and is only of importance to you if +# you choose to contribute your changes and enhancements to the +# community by submitting them to Best Practical Solutions, LLC.) # +# By intentionally submitting any modifications, corrections or +# derivatives to this work, or any other work intended for use with +# Request Tracker, to Best Practical Solutions, LLC, you confirm that +# you are the copyright holder for those contributions and you grant +# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable, +# royalty-free, perpetual, license to use, copy, create derivative +# works based on those contributions, and sublicense and distribute +# those contributions and any derivatives thereof. # -# END LICENSE BLOCK +# END BPS TAGGED BLOCK }}} =head1 NAME RT::Transaction - RT\'s transaction object @@ -48,12 +72,20 @@ ok(require RT::Transaction); =cut + +package RT::Transaction; + use strict; no warnings qw(redefine); -use vars qw( %_BriefDescriptions ); +use vars qw( %_BriefDescriptions $PreferredContentType ); use RT::Attachments; +use RT::Scrips; + +use HTML::FormatText; +use HTML::TreeBuilder; + # {{{ sub Create @@ -61,8 +93,9 @@ use RT::Attachments; Create a new transaction. -This routine should _never_ be called anything other Than RT::Ticket. It should not be called -from client code. Ever. Not ever. If you do this, we will hunt you down. and break your kneecaps. +This routine should _never_ be called by anything other than RT::Ticket. +It should not be called +from client code. Ever. Not ever. If you do this, we will hunt you down and break your kneecaps. Then the unpleasant stuff will start. TODO: Document what gets passed to this @@ -74,7 +107,6 @@ sub Create { my %args = ( id => undef, TimeTaken => 0, - Ticket => 0, Type => 'undefined', Data => '', Field => undef, @@ -82,24 +114,37 @@ sub Create { NewValue => undef, MIMEObj => undef, ActivateScrips => 1, + CommitScrips => 1, + ObjectType => 'RT::Ticket', + ObjectId => 0, + ReferenceType => undef, + OldReference => undef, + NewReference => undef, @_ ); + $args{ObjectId} ||= $args{Ticket}; + #if we didn't specify a ticket, we need to bail - unless ( $args{'Ticket'} ) { - return ( 0, $self->loc( "Transaction->Create couldn't, as you didn't specify a ticket id")); + unless ( $args{'ObjectId'} && $args{'ObjectType'}) { + return ( 0, $self->loc( "Transaction->Create couldn't, as you didn't specify an object type and id")); } #lets create our transaction - my %params = (Ticket => $args{'Ticket'}, + my %params = ( Type => $args{'Type'}, Data => $args{'Data'}, Field => $args{'Field'}, OldValue => $args{'OldValue'}, NewValue => $args{'NewValue'}, - Created => $args{'Created'} + Created => $args{'Created'}, + ObjectType => $args{'ObjectType'}, + ObjectId => $args{'ObjectId'}, + ReferenceType => $args{'ReferenceType'}, + OldReference => $args{'OldReference'}, + NewReference => $args{'NewReference'}, ); # Parameters passed in during an import that we probably don't want to touch, otherwise @@ -109,18 +154,32 @@ sub Create { my $id = $self->SUPER::Create(%params); $self->Load($id); - $self->_Attach( $args{'MIMEObj'} ) - if defined $args{'MIMEObj'}; + if ( defined $args{'MIMEObj'} ) { + my ($id, $msg) = $self->_Attach( $args{'MIMEObj'} ); + unless ( $id ) { + $RT::Logger->error("Couldn't add attachment: $msg"); + return ( 0, $self->loc("Couldn't add attachment") ); + } + } + #Provide a way to turn off scrips if we need to - if ( $args{'ActivateScrips'} ) { - require RT::Scrips; - RT::Scrips->new($RT::SystemUser)->Apply( + $RT::Logger->debug('About to think about scrips for transaction #' .$self->Id); + if ( $args{'ActivateScrips'} and $args{'ObjectType'} eq 'RT::Ticket' ) { + $self->{'scrips'} = RT::Scrips->new($RT::SystemUser); + + $RT::Logger->debug('About to prepare scrips for transaction #' .$self->Id); + + $self->{'scrips'}->Prepare( Stage => 'TransactionCreate', Type => $args{'Type'}, - Ticket => $args{'Ticket'}, + Ticket => $args{'ObjectId'}, Transaction => $self->id, ); + if ($args{'CommitScrips'} ) { + $RT::Logger->debug('About to commit scrips for transaction #' .$self->Id); + $self->{'scrips'}->Commit(); + } } return ( $id, $self->loc("Transaction Created") ); @@ -128,12 +187,52 @@ sub Create { # }}} +=head2 Scrips + +Returns the Scrips object for this transaction. +This routine is only useful on a freshly created transaction object. +Scrips do not get persisted to the database with transactions. + + +=cut + + +sub Scrips { + my $self = shift; + return($self->{'scrips'}); +} + + # {{{ sub Delete +=head2 Delete + +Delete this transaction. Currently DOES NOT CHECK ACLS + +=cut + sub Delete { my $self = shift; - return ( 0, - $self->loc('Deleting this object could break referential integrity') ); + + + $RT::Handle->BeginTransaction(); + + my $attachments = $self->Attachments; + + while (my $attachment = $attachments->Next) { + my ($id, $msg) = $attachment->Delete(); + unless ($id) { + $RT::Handle->Rollback(); + return($id, $self->loc("System Error: [_1]", $msg)); + } + } + my ($id,$msg) = $self->SUPER::Delete(); + unless ($id) { + $RT::Handle->Rollback(); + return($id, $self->loc("System Error: [_1]", $msg)); + } + $RT::Handle->Commit(); + return ($id,$msg); } # }}} @@ -172,27 +271,55 @@ sub Message { =head2 Content PARAMHASH -If this transaction has attached mime objects, returns the first text/plain part. -Otherwise, returns undef. +If this transaction has attached mime objects, returns the body of the first +textual part (as defined in RT::I18N::IsTextualContentType). Otherwise, +returns undef. Takes a paramhash. If the $args{'Quote'} parameter is set, wraps this message at $args{'Wrap'}. $args{'Wrap'} defaults to 70. +If $args{'Type'} is set to C, plain texts are upgraded to HTML. +Otherwise, HTML texts are downgraded to plain text. If $args{'Type'} is +missing, it defaults to the value of C<$RT::Transaction::PreferredContentType>. =cut sub Content { my $self = shift; my %args = ( + Type => $PreferredContentType, Quote => 0, Wrap => 70, @_ ); my $content; - my $content_obj = $self->ContentObj; - if ($content_obj) { + if (my $content_obj = $self->ContentObj) { $content = $content_obj->Content; + + if ($content_obj->ContentType =~ m{^text/html$}i) { + $content =~ s/

--\s+
.*?$//s if $args{'Quote'}; + + if ($args{Type} ne 'text/html') { + $content = HTML::FormatText->new( + leftmargin => 0, + rightmargin => 78, + )->format( + HTML::TreeBuilder->new_from_content( $content ) + ); + } + } + else { + $content =~ s/\n-- \n.*?$//s if $args{'Quote'}; + + if ($args{Type} eq 'text/html') { + # Extremely simple text->html converter + $content =~ s/&/&/g; + $content =~ s//>/g; + $content = "

$content
"; + } + } } # If all else fails, return a message that we couldn't find any content @@ -202,9 +329,6 @@ sub Content { if ( $args{'Quote'} ) { - # Remove quoted signature. - $content =~ s/\n-- \n(.*?)$//s; - # What's the longest line like? my $max = 0; foreach ( split ( /\n/, $content ) ) { @@ -222,10 +346,8 @@ sub Content { } $content =~ s/^/> /gm; - $content = '[' - . $self->CreatorObj->Name() . ' - ' - . $self->CreatedAsString() . "]:\n" . $content . "\n\n"; - + $content = $self->loc("On [_1], [_2] wrote:", $self->CreatedAsString(), $self->CreatorObj->Name()) + . "\n$content\n\n"; } return ($content); @@ -242,7 +364,6 @@ Returns the RT::Attachment object which contains the content for this Transactio =cut - sub ContentObj { my $self = shift; @@ -255,31 +376,30 @@ sub ContentObj { # Get the set of toplevel attachments to this transaction. my $Attachment = $self->Attachments->First(); - # If it's a message or a plain part, just return the - # body. - if ( $Attachment->ContentType() =~ '^(text/plain$|message/)' ) { + # If it's a textual part, just return the body. + if ( RT::I18N::IsTextualContentType($Attachment->ContentType) ) { return ($Attachment); } - # If it's a multipart object, first try returning the first - # text/plain part. + # If it's a multipart object, first try returning the first part with preferred + # MIME type ('text/plain' by default). elsif ( $Attachment->ContentType() =~ '^multipart/' ) { my $plain_parts = $Attachment->Children(); - $plain_parts->ContentType( VALUE => 'text/plain' ); + $plain_parts->ContentType( VALUE => ($PreferredContentType || 'text/plain') ); # If we actully found a part, return its content if ( $plain_parts->First && $plain_parts->First->Content ne '' ) { return ( $plain_parts->First ); } - # If that fails, return the first text/plain or message/ part - # which has some content. + + # If that fails, return the first textual part which has some content. else { - my $all_parts = $Attachment->Children(); + my $all_parts = $self->Attachments(); while ( my $part = $all_parts->Next ) { - if (( $part->ContentType() =~ '^(text/plain$|message/)' ) && $part->Content() ) { + if ( ( RT::I18N::IsTextualContentType($part->ContentType) ) and ( $part->Content() ne '' ) ) { return ($part); } } @@ -338,7 +458,7 @@ sub Attachments { } #if they ain't got rights to see, return an empty object - else { + elsif ($self->__Value('ObjectType') eq "RT::Ticket") { unless ( $self->CurrentUserHasRight('ShowTicket') ) { return ( $self->{'attachments'} ); } @@ -383,11 +503,11 @@ sub _Attach { } my $Attachment = new RT::Attachment( $self->CurrentUser ); - $Attachment->Create( + my ($id, $msg) = $Attachment->Create( TransactionId => $self->Id, Attachment => $MIMEObject ); - return ( $Attachment, $self->loc("Attachment created") ); + return ( $Attachment, $msg || $self->loc("Attachment created") ); } @@ -409,15 +529,17 @@ sub Description { my $self = shift; #Check those ACLs - #If it's a comment, we need to be extra special careful - if ( $self->__Value('Type') eq 'Comment' ) { + #If it's a comment or a comment email record, + # we need to be extra special careful + + if ( $self->__Value('Type') =~ /^Comment/ ) { unless ( $self->CurrentUserHasRight('ShowTicketComments') ) { return ( $self->loc("Permission Denied") ); } } #if they ain't got rights to see, don't let em - else { + elsif ($self->__Value('ObjectType') eq "RT::Ticket") { unless ( $self->CurrentUserHasRight('ShowTicket') ) { return ($self->loc("Permission Denied") ); } @@ -443,55 +565,87 @@ Returns a text string which briefly describes this transaction sub BriefDescription { my $self = shift; - - #Check those ACLs - #If it's a comment, we need to be extra special careful - if ( $self->__Value('Type') eq 'Comment' ) { + #If it's a comment or a comment email record, + # we need to be extra special careful + if ( $self->__Value('Type') =~ /^Comment/ ) { unless ( $self->CurrentUserHasRight('ShowTicketComments') ) { return ( $self->loc("Permission Denied") ); } } #if they ain't got rights to see, don't let em - else { + elsif ( $self->__Value('ObjectType') eq "RT::Ticket" ) { unless ( $self->CurrentUserHasRight('ShowTicket') ) { return ( $self->loc("Permission Denied") ); } } - my $type = $self->Type; #cache this, rather than calling it 30 times + my $type = $self->Type; #cache this, rather than calling it 30 times - if ( !defined( $type ) ) { + if ( !defined($type) ) { return $self->loc("No transaction type specified"); } + my $obj_type = $self->FriendlyObjectType; + if ( $type eq 'Create' ) { - return ($self->loc("Ticket created")); + return ( $self->loc( "[_1] created", $obj_type ) ); } elsif ( $type =~ /Status/ ) { if ( $self->Field eq 'Status' ) { if ( $self->NewValue eq 'deleted' ) { - return ($self->loc("Ticket deleted")); + return ( $self->loc( "[_1] deleted", $obj_type ) ); } else { - return ( $self->loc("Status changed from [_1] to [_2]", $self->loc($self->OldValue), $self->loc($self->NewValue) )); + return ( + $self->loc( + "Status changed from [_1] to [_2]", + "'" . $self->loc( $self->OldValue ) . "'", + "'" . $self->loc( $self->NewValue ) . "'" + ) + ); } } # Generic: - my $no_value = $self->loc("(no value)"); - return ( $self->loc( "[_1] changed from [_2] to [_3]", $self->Field , ( $self->OldValue || $no_value ) , $self->NewValue )); + my $no_value = $self->loc("(no value)"); + return ( + $self->loc( + "[_1] changed from [_2] to [_3]", + $self->Field, + ( $self->OldValue ? "'" . $self->OldValue . "'" : $no_value ), + "'" . $self->NewValue . "'" + ) + ); } - if (my $code = $_BriefDescriptions{$type}) { + if ( my $code = $_BriefDescriptions{$type} ) { return $code->($self); } - return $self->loc( "Default: [_1]/[_2] changed from [_3] to [_4]", $type, $self->Field, $self->OldValue, $self->NewValue ); + return $self->loc( + "Default: [_1]/[_2] changed from [_3] to [_4]", + $type, + $self->Field, + ( + $self->OldValue + ? "'" . $self->OldValue . "'" + : $self->loc("(no value)") + ), + "'" . $self->NewValue . "'" + ); } %_BriefDescriptions = ( + CommentEmailRecord => sub { + my $self = shift; + return $self->loc("Outgoing email about a comment recorded"); + }, + EmailRecord => sub { + my $self = shift; + return $self->loc("Outgoing email recorded"); + }, Correspond => sub { my $self = shift; return $self->loc("Correspondence added"); @@ -542,7 +696,7 @@ sub BriefDescription { my $self = shift; my $Old = RT::User->new( $self->CurrentUser ); $Old->Load( $self->OldValue ); - return $self->loc("Stolen from [_1] ", $Old->Name); + return $self->loc("Stolen from [_1]", $Old->Name); }, Give => sub { my $self = shift; @@ -644,7 +798,10 @@ sub BriefDescription { }, Set => sub { my $self = shift; - if ( $self->Field eq 'Queue' ) { + if ( $self->Field eq 'Password' ) { + return $self->loc('Password changed'); + } + elsif ( $self->Field eq 'Queue' ) { my $q1 = new RT::Queue( $self->CurrentUser ); $q1->Load( $self->OldValue ); my $q2 = new RT::Queue( $self->CurrentUser ); @@ -661,13 +818,34 @@ sub BriefDescription { return $self->loc( "[_1] changed from [_2] to [_3]", $self->Field, $t2->AsString, $t1->AsString ); } else { - return $self->loc( "[_1] changed from [_2] to [_3]", $self->Field, $self->OldValue, $self->NewValue ); + return $self->loc( "[_1] changed from [_2] to [_3]", $self->Field, ($self->OldValue? "'".$self->OldValue ."'" : $self->loc("(no value)")) , "'". $self->NewValue."'" ); } }, PurgeTransaction => sub { my $self = shift; return $self->loc("Transaction [_1] purged", $self->Data); }, + AddReminder => sub { + my $self = shift; + my $ticket = RT::Ticket->new($self->CurrentUser); + $ticket->Load($self->NewValue); + return $self->loc("Reminder '[_1]' added", $ticket->Subject); + }, + OpenReminder => sub { + my $self = shift; + my $ticket = RT::Ticket->new($self->CurrentUser); + $ticket->Load($self->NewValue); + return $self->loc("Reminder '[_1]' reopened", $ticket->Subject); + + }, + ResolveReminder => sub { + my $self = shift; + my $ticket = RT::Ticket->new($self->CurrentUser); + $ticket->Load($self->NewValue); + return $self->loc("Reminder '[_1]' completed", $ticket->Subject); + + + } ); # }}} @@ -685,6 +863,7 @@ Returns false otherwise sub IsInbound { my $self = shift; + $self->ObjectType eq 'RT::Ticket' or return undef; return ( $self->TicketObj->IsRequestor( $self->CreatorObj->PrincipalId ) ); } @@ -692,23 +871,11 @@ sub IsInbound { # }}} -sub _ClassAccessible { +sub _OverlayAccessible { { - id => { read => 1, type => 'int(11)', default => '' }, - EffectiveTicket => - { read => 1, write => 1, type => 'int(11)', default => '' }, - Ticket => - { read => 1, public => 1, type => 'int(11)', default => '' }, - TimeTaken => { read => 1, type => 'int(11)', default => '' }, - Type => { read => 1, type => 'varchar(20)', default => '' }, - Field => { read => 1, type => 'varchar(40)', default => '' }, - OldValue => { read => 1, type => 'varchar(255)', default => '' }, - NewValue => { read => 1, type => 'varchar(255)', default => '' }, - Data => { read => 1, type => 'varchar(100)', default => '' }, - Creator => { read => 1, auto => 1, type => 'int(11)', default => '' }, - Created => - { read => 1, auto => 1, type => 'datetime', default => '' }, + ObjectType => { public => 1}, + ObjectId => { public => 1}, } }; @@ -752,9 +919,29 @@ sub _Value { return (undef); } } + elsif ( $self->__Value('Type') eq 'CommentEmailRecord' ) { + unless ( $self->CurrentUserHasRight('ShowTicketComments') + && $self->CurrentUserHasRight('ShowOutgoingEmail') ) { + return (undef); + } + + } + elsif ( $self->__Value('Type') eq 'EmailRecord' ) { + unless ( $self->CurrentUserHasRight('ShowOutgoingEmail')) { + return (undef); + } + + } + # Make sure the user can see the custom field before showing that it changed + elsif ( ( $self->__Value('Type') eq 'CustomField' ) && $self->__Value('Field') ) { + my $cf = RT::CustomField->new( $self->CurrentUser ); + $cf->Load( $self->__Value('Field') ); + return (undef) unless ( $cf->CurrentUserHasRight('SeeCustomField') ); + } + #if they ain't got rights to see, don't let em - else { + elsif ($self->__Value('ObjectType') eq "RT::Ticket") { unless ( $self->CurrentUserHasRight('ShowTicket') ) { return (undef); } @@ -788,6 +975,154 @@ sub CurrentUserHasRight { # }}} +sub Ticket { + my $self = shift; + return $self->ObjectId; +} + +sub TicketObj { + my $self = shift; + return $self->Object; +} + +sub OldValue { + my $self = shift; + if ( my $type = $self->__Value('ReferenceType') + and my $id = $self->__Value('OldReference') ) + { + my $Object = $type->new($self->CurrentUser); + $Object->Load( $id ); + return $Object->Content; + } + else { + return $self->__Value('OldValue'); + } +} + +sub NewValue { + my $self = shift; + if ( my $type = $self->__Value('ReferenceType') + and my $id = $self->__Value('NewReference') ) + { + my $Object = $type->new($self->CurrentUser); + $Object->Load( $id ); + return $Object->Content; + } + else { + return $self->__Value('NewValue'); + } +} + +sub Object { + my $self = shift; + my $Object = $self->__Value('ObjectType')->new($self->CurrentUser); + $Object->Load($self->__Value('ObjectId')); + return($Object); +} + +sub FriendlyObjectType { + my $self = shift; + my $type = $self->ObjectType or return undef; + $type =~ s/^RT:://; + return $self->loc($type); +} + +=head2 UpdateCustomFields + + Takes a hash of + + CustomField-<> => Value + or + + Object-RT::Transaction-CustomField-<> => Value parameters to update + this transaction's custom fields + +=cut + +sub UpdateCustomFields { + my $self = shift; + my %args = (@_); + + # This method used to have an API that took a hash of a single + # value "ARGSRef", which was a reference to a hash of arguments. + # This was insane. The next few lines of code preserve that API + # while giving us something saner. + + + # TODO: 3.6: DEPRECATE OLD API + + my $args; + + if ($args{'ARGSRef'}) { + $args = $args{ARGSRef}; + } else { + $args = \%args; + } + + foreach my $arg ( keys %$args ) { + next + unless ( $arg =~ + /^(?:Object-RT::Transaction--)?CustomField-(\d+)/ ); + next if $arg =~ /-Magic$/; + my $cfid = $1; + my $values = $args->{$arg}; + foreach + my $value ( UNIVERSAL::isa( $values, 'ARRAY' ) ? @$values : $values ) + { + next unless length($value); + $self->_AddCustomFieldValue( + Field => $cfid, + Value => $value, + RecordTransaction => 0, + ); + } + } +} + + + +=head2 CustomFieldValues + + Do name => id mapping (if needed) before falling back to RT::Record's CustomFieldValues + + See L + +=cut + +sub CustomFieldValues { + my $self = shift; + my $field = shift; + + if ( UNIVERSAL::can( $self->Object, 'QueueObj' ) ) { + + unless ( defined $field && $field =~ /^\d+$/o ) { + my $CFs = RT::CustomFields->new( $self->CurrentUser ); + $CFs->Limit( FIELD => 'Name', VALUE => $field); + $CFs->LimitToLookupType($self->CustomFieldLookupType); + $CFs->LimitToGlobalOrObjectId($self->Object->QueueObj->id); + $field = $CFs->First->id if $CFs->First; + } + } + return $self->SUPER::CustomFieldValues($field); +} + +# }}} + +# {{{ sub CustomFieldLookupType + +=head2 CustomFieldLookupType + +Returns the RT::Transaction lookup type, which can +be passed to RT::CustomField->Create() via the 'LookupType' hash key. + +=cut + +# }}} + +sub CustomFieldLookupType { + "RT::Queue-RT::Ticket-RT::Transaction"; +} + # Transactions don't change. by adding this cache congif directiove, we don't lose pathalogically on long tickets. sub _CacheConfig { {