X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=rt%2Flib%2FRT%2FAttachment.pm;h=e9a3dc6e6bb0e8544cf465165ea59103acc3eb27;hb=5a5e999c1995dc74e90a5bec660e28692b81611e;hp=916ac355e17f22bc304f5d704232be8586f88879;hpb=0ebeec96313dd7edfca340f01f8fbbbac1f4aa1d;p=freeside.git

diff --git a/rt/lib/RT/Attachment.pm b/rt/lib/RT/Attachment.pm
index 916ac355e..e9a3dc6e6 100755
--- a/rt/lib/RT/Attachment.pm
+++ b/rt/lib/RT/Attachment.pm
@@ -1,423 +1,380 @@
-# $Header: /home/cvs/cvsroot/freeside/rt/lib/RT/Attachment.pm,v 1.1 2002-08-12 06:17:07 ivan Exp $
-# Copyright 2000 Jesse Vincent <jesse@fsck.com>
-# Released under the terms of the GNU Public License
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2011 Best Practical Solutions, LLC
+#                                          <sales@bestpractical.com>
+#
+# (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
+# been provided with this software, but in any event can be snarfed
+# from www.gnu.org.
+#
+# This work is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# 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/licenses/old-licenses/gpl-2.0.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 BPS TAGGED BLOCK }}}
+
+# Autogenerated by DBIx::SearchBuilder factory (by <jesse@bestpractical.com>)
+# WARNING: THIS FILE IS AUTOGENERATED. ALL CHANGES TO THIS FILE WILL BE LOST.  
+# 
+# !! DO NOT EDIT THIS FILE !!
+#
+
+use strict;
+
 
 =head1 NAME
 
-  RT::Attachment -- an RT attachment object
+RT::Attachment
+
 
 =head1 SYNOPSIS
 
-  use RT::Attachment;
+=head1 DESCRIPTION
 
+=head1 METHODS
 
-=head1 DESCRIPTION
+=cut
 
-This module should never be instantiated directly by client code. it's an internal 
-module which should only be instantiated through exported APIs in Ticket, Queue and other 
-similar objects.
+package RT::Attachment;
+use RT::Record; 
 
 
-=head1 METHODS
+use vars qw( @ISA );
+@ISA= qw( RT::Record );
+
+sub _Init {
+  my $self = shift; 
+
+  $self->Table('Attachments');
+  $self->SUPER::_Init(@_);
+}
+
 
 
-=begin testing
 
-ok (require RT::TestHarness);
-ok (require RT::Attachment);
 
-=end testing
+=head2 Create PARAMHASH
+
+Create takes a hash of values and creates a row in the database:
+
+  int(11) 'TransactionId'.
+  int(11) 'Parent'.
+  varchar(160) 'MessageId'.
+  varchar(255) 'Subject'.
+  varchar(255) 'Filename'.
+  varchar(80) 'ContentType'.
+  varchar(80) 'ContentEncoding'.
+  longtext 'Content'.
+  longtext 'Headers'.
 
 =cut
 
-package RT::Attachment;
-use RT::Record;
-use MIME::Base64;
-use vars qw|@ISA|;
-@ISA= qw(RT::Record);
-
-# {{{ sub _Init
-sub _Init  {
-    my $self = shift; 
-    $self->{'table'} = "Attachments";
-    return($self->SUPER::_Init(@_));
-}
-# }}}
 
-# {{{ sub _ClassAccessible 
-sub _ClassAccessible {
-    {
-    TransactionId   => { 'read'=>1, 'public'=>1, },
-    MessageId       => { 'read'=>1, },
-    Parent          => { 'read'=>1, },
-    ContentType     => { 'read'=>1, },
-    Subject         => { 'read'=>1, },
-    Content         => { 'read'=>1, },
-    ContentEncoding => { 'read'=>1, },
-    Headers         => { 'read'=>1, },
-    Filename        => { 'read'=>1, },
-    Creator         => { 'read'=>1, 'auto'=>1, },
-    Created         => { 'read'=>1, 'auto'=>1, },
-  };
+
+
+sub Create {
+    my $self = shift;
+    my %args = ( 
+                TransactionId => '0',
+                Parent => '0',
+                MessageId => '',
+                Subject => '',
+                Filename => '',
+                ContentType => '',
+                ContentEncoding => '',
+                Content => '',
+                Headers => '',
+
+		  @_);
+    $self->SUPER::Create(
+                         TransactionId => $args{'TransactionId'},
+                         Parent => $args{'Parent'},
+                         MessageId => $args{'MessageId'},
+                         Subject => $args{'Subject'},
+                         Filename => $args{'Filename'},
+                         ContentType => $args{'ContentType'},
+                         ContentEncoding => $args{'ContentEncoding'},
+                         Content => $args{'Content'},
+                         Headers => $args{'Headers'},
+);
+
 }
-# }}}
 
-# {{{ sub TransactionObj 
 
-=head2 TransactionObj
 
-Returns the transaction object asscoiated with this attachment.
+=head2 id
+
+Returns the current value of id. 
+(In the database, id is stored as int(11).)
+
 
 =cut
 
-sub TransactionObj {
-    require RT::Transaction;
-    my $self=shift;
-    unless (exists $self->{_TransactionObj}) {
-	$self->{_TransactionObj}=RT::Transaction->new($self->CurrentUser);
-	$self->{_TransactionObj}->Load($self->TransactionId);
-    }
-    return $self->{_TransactionObj};
-}
 
-# }}}
+=head2 TransactionId
+
+Returns the current value of TransactionId. 
+(In the database, TransactionId is stored as int(11).)
+
 
-# {{{ sub Create 
 
-=head2 Create
+=head2 SetTransactionId VALUE
+
+
+Set TransactionId to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, TransactionId will be stored as a int(11).)
 
-Create a new attachment. Takes a paramhash:
-    
-    'Attachment' Should be a single MIME body with optional subparts
-    'Parent' is an optional Parent RT::Attachment object
-    'TransactionId' is the mandatory id of the Transaction this attachment is associated with.;
 
 =cut
 
-sub Create  {
-    my $self = shift;
-    my ($id);
-    my %args = ( id => 0,
-		 TransactionId => 0,
-		 Parent => 0,
-		 Attachment => undef,
-		 @_
-	       );
-    
-    
-    #For ease of reference
-    my $Attachment = $args{'Attachment'};
-    
-    #if we didn't specify a ticket, we need to bail
-    if ( $args{'TransactionId'} == 0) {
-	$RT::Logger->crit("RT::Attachment->Create couldn't, as you didn't specify a transaction\n");
-	return (0);
-	
-    }
-    
-    #If we possibly can, collapse it to a singlepart
-    $Attachment->make_singlepart;
-    
-    #Get the subject
-    my $Subject = $Attachment->head->get('subject',0);
-    defined($Subject) or $Subject = '';
-    chomp($Subject);
-  
-    #Get the filename
-    my $Filename = $Attachment->head->recommended_filename;
-    
-    if ($Attachment->parts) {
-	$id = $self->SUPER::Create(TransactionId => $args{'TransactionId'},
-				   Parent => 0,
-				   ContentType  => $Attachment->mime_type,
-				   Headers => $Attachment->head->as_string,
-				   Subject => $Subject,
-				   
-				  );
- 	foreach my $part ($Attachment->parts) {	
-	    my $SubAttachment = new RT::Attachment($self->CurrentUser);
-	    $SubAttachment->Create(TransactionId => $args{'TransactionId'},
-				   Parent => $id,
-				   Attachment => $part,
-				   ContentType  => $Attachment->mime_type,
-				   Headers => $Attachment->head->as_string(),
-				   
-				  );
-	}
-	return ($id);
-    }
-  
-  
-    #If it's not multipart
-    else {
-	
-	my $ContentEncoding = 'none'; 
-	
-	my $Body = $Attachment->bodyhandle->as_string;
-	
-	#get the max attachment length from RT
-	my $MaxSize = $RT::MaxAttachmentSize;
-	
-	#if the current attachment contains nulls and the 
-	#database doesn't support embedded nulls
-	
-	if ( (! $RT::Handle->BinarySafeBLOBs) &&
-	     ( $Body =~ /\x00/ ) ) {
-	    # set a flag telling us to mimencode the attachment
-	    $ContentEncoding = 'base64';
-	    
-	    #cut the max attchment size by 25% (for mime-encoding overhead.
-	    $RT::Logger->debug("Max size is $MaxSize\n");
-	    $MaxSize = $MaxSize * 3/4;	
-	}
-	
-	#if the attachment is larger than the maximum size
-	if (($MaxSize) and ($MaxSize < length($Body))) {
-	    # if we're supposed to truncate large attachments
-	    if ($RT::TruncateLongAttachments) {
-		# truncate the attachment to that length.
-		$Body = substr ($Body, 0, $MaxSize);
-
-	    }
-	    
-	    # elsif we're supposed to drop large attachments on the floor,
-	    elsif ($RT::DropLongAttachments) {
-		# drop the attachment on the floor
-		$RT::Logger->info("$self: Dropped an attachment of size ". length($Body).
-				  "\n". "It started: ". substr($Body, 0, 60) . "\n");
-		return(undef);
-	    }
-	}
-	# if we need to mimencode the attachment
-	if ($ContentEncoding eq 'base64') {
-	    # base64 encode the attachment
-	    $Body = MIME::Base64::encode_base64($Body);
-	    
-	}
-	
-	my $id = $self->SUPER::Create(TransactionId => $args{'TransactionId'},
-				      ContentType  => $Attachment->mime_type,
-				      ContentEncoding => $ContentEncoding,
-				      Parent => $args{'Parent'},
-				      Content => $Body,
-				      Headers => $Attachment->head->as_string,
-				      Subject => $Subject,
-				      Filename => $Filename,
-				     );
-	return ($id);
-    }
-}
 
-# }}}
+=head2 Parent
 
+Returns the current value of Parent. 
+(In the database, Parent is stored as int(11).)
 
-# {{{ sub Content
 
-=head2 Content
 
-Returns the attachment's content. if it's base64 encoded, decode it 
-before returning it.
+=head2 SetParent VALUE
+
+
+Set Parent to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Parent will be stored as a int(11).)
+
 
 =cut
 
-sub Content {
-  my $self = shift;
-  if ( $self->ContentEncoding eq 'none' || ! $self->ContentEncoding ) {
-      return $self->_Value('Content');
-  } elsif ( $self->ContentEncoding eq 'base64' ) {
-      return MIME::Base64::decode_base64($self->_Value('Content'));
-  } else {
-      return( "Unknown ContentEncoding ". $self->ContentEncoding);
-  }
-}
+
+=head2 MessageId
+
+Returns the current value of MessageId. 
+(In the database, MessageId is stored as varchar(160).)
 
 
-# }}}
 
-# {{{ sub Children
+=head2 SetMessageId VALUE
 
-=head2 Children
 
-  Returns an RT::Attachments object which is preloaded with all Attachments objects with this Attachment\'s Id as their 'Parent'
+Set MessageId to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, MessageId will be stored as a varchar(160).)
+
 
 =cut
 
-sub Children {
-    my $self = shift;
-    
-    my $kids = new RT::Attachments($self->CurrentUser);
-    $kids->ChildrenOf($self->Id);
-    return($kids);
-}
 
-# }}}
+=head2 Subject
 
-# {{{ UTILITIES
+Returns the current value of Subject. 
+(In the database, Subject is stored as varchar(255).)
 
-# {{{ sub Quote 
 
 
+=head2 SetSubject VALUE
 
-sub Quote {
-    my $self=shift;
-    my %args=(Reply=>undef, # Prefilled reply (i.e. from the KB/FAQ system)
-	      @_);
 
-    my ($quoted_content, $body, $headers);
-    my $max=0;
+Set Subject to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Subject will be stored as a varchar(255).)
 
-    # TODO: Handle Multipart/Mixed (eventually fix the link in the
-    # ShowHistory web template?)
-    if ($self->ContentType =~ m{^(text/plain|message)}i) {
-	$body=$self->Content;
 
-	# Do we need any preformatting (wrapping, that is) of the message?
+=cut
 
-	# Remove quoted signature.
-	$body =~ s/\n-- \n(.*)$//s;
 
-	# What's the longest line like?
-	foreach (split (/\n/,$body)) {
-	    $max=length if ( length > $max);
-	}
+=head2 Filename
 
-	if ($max>76) {
-	    require Text::Wrapper;
-	    my $wrapper=new Text::Wrapper
-		(
-		 columns => 70, 
-		 body_start => ($max > 70*3 ? '   ' : ''),
-		 par_start => ''
-		 );
-	    $body=$wrapper->wrap($body);
-	}
+Returns the current value of Filename. 
+(In the database, Filename is stored as varchar(255).)
 
-	$body =~ s/^/> /gm;
 
-	$body = '[' . $self->TransactionObj->CreatorObj->Name() . ' - ' . $self->TransactionObj->CreatedAsString()
-	            . "]:\n\n"
-   	        . $body . "\n\n";
 
-    } else {
-	$body = "[Non-text message not quoted]\n\n";
-    }
-    
-    $max=60 if $max<60;
-    $max=70 if $max>78;
-    $max+=2;
+=head2 SetFilename VALUE
 
-    return (\$body, $max);
-}
-# }}}
 
-# {{{ sub NiceHeaders - pulls out only the most relevant headers
+Set Filename to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Filename will be stored as a varchar(255).)
+
+
+=cut
 
-=head2 NiceHeaders
 
-Returns the To, From, Cc, Date and Subject headers.
+=head2 ContentType
+
+Returns the current value of ContentType. 
+(In the database, ContentType is stored as varchar(80).)
+
+
+
+=head2 SetContentType VALUE
+
+
+Set ContentType to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, ContentType will be stored as a varchar(80).)
 
-It is a known issue that this breaks if any of these headers are not
-properly unfolded.
 
 =cut
 
-sub NiceHeaders {
-    my $self=shift;
-    my $hdrs="";
-    for (split(/\n/,$self->Headers)) {
-	    $hdrs.="$_\n" if /^(To|From|RT-Send-Cc|Cc|Date|Subject): /i
-    }
-    return $hdrs;
-}
-# }}}
 
-# {{{ sub Headers
+=head2 ContentEncoding
 
-=head2 Headers
+Returns the current value of ContentEncoding. 
+(In the database, ContentEncoding is stored as varchar(80).)
+
+
+
+=head2 SetContentEncoding VALUE
+
+
+Set ContentEncoding to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, ContentEncoding will be stored as a varchar(80).)
 
-Returns this object's headers as a string.  This method specifically
-removes the RT-Send-Bcc: header, so as to never reveal to whom RT sent a Bcc.
-We need to record the RT-Send-Cc and RT-Send-Bcc values so that we can actually send
-out mail. (The mailing rules are seperated from the ticket update code by
-an abstraction barrier that makes it impossible to pass this data directly
 
 =cut
 
-sub Headers {
-    my $self = shift;
-    my $hdrs="";
-    for (split(/\n/,$self->SUPER::Headers)) {
-	    $hdrs.="$_\n" unless /^(RT-Send-Bcc): /i
-    }
-    return $hdrs;
-}
 
+=head2 Content
+
+Returns the current value of Content. 
+(In the database, Content is stored as longtext.)
 
-# }}}
 
-# {{{ sub GetHeader
 
-=head2 GetHeader ( 'Tag')
+=head2 SetContent VALUE
+
+
+Set Content to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Content will be stored as a longtext.)
 
-Returns the value of the header Tag as a string. This bypasses the weeding out
-done in Headers() above.
 
 =cut
 
-sub GetHeader {
-    my $self = shift;
-    my $tag = shift;
-    foreach my $line (split(/\n/,$self->SUPER::Headers)) {
-        $RT::Logger->debug( "Does $line match $tag\n");
-        if ($line =~ /^$tag:\s+(.*)$/i) { #if we find the header, return its value
-            return ($1);
-        }
-    }
-    
-    # we found no header. return an empty string
-    return undef;
-}
-# }}}
 
-# {{{ sub _Value 
+=head2 Headers
+
+Returns the current value of Headers. 
+(In the database, Headers is stored as longtext.)
+
+
 
-=head2 _Value
+=head2 SetHeaders VALUE
+
+
+Set Headers to VALUE. 
+Returns (1, 'Status message') on success and (0, 'Error Message') on failure.
+(In the database, Headers will be stored as a longtext.)
 
-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')) {
-	#$RT::Logger->debug("Skipping ACL check for $field\n");
-	return($self->__Value($field));
-	
-    }
-    
-    #If it's a comment, we need to be extra special careful
-    elsif ( (($self->TransactionObj->CurrentUserHasRight('ShowTicketComments')) and
-	     ($self->TransactionObj->Type eq 'Comment') )  or
-	    ($self->TransactionObj->CurrentUserHasRight('ShowTicket'))) {
-	
-	return($self->__Value($field));
-    }
-    #if they ain't got rights to see, don't let em
-    else {
-	    return(undef);
-	}
-    	
-    
-}
+=head2 Creator
+
+Returns the current value of Creator. 
+(In the database, Creator is stored as int(11).)
+
+
+=cut
 
-# }}}
 
-# }}}
+=head2 Created
+
+Returns the current value of Created. 
+(In the database, Created is stored as datetime.)
+
+
+=cut
+
+
+
+sub _CoreAccessible {
+    {
+     
+        id =>
+		{read => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => ''},
+        TransactionId => 
+		{read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
+        Parent => 
+		{read => 1, write => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
+        MessageId => 
+		{read => 1, write => 1, sql_type => 12, length => 160,  is_blob => 0,  is_numeric => 0,  type => 'varchar(160)', default => ''},
+        Subject => 
+		{read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
+        Filename => 
+		{read => 1, write => 1, sql_type => 12, length => 255,  is_blob => 0,  is_numeric => 0,  type => 'varchar(255)', default => ''},
+        ContentType => 
+		{read => 1, write => 1, sql_type => 12, length => 80,  is_blob => 0,  is_numeric => 0,  type => 'varchar(80)', default => ''},
+        ContentEncoding => 
+		{read => 1, write => 1, sql_type => 12, length => 80,  is_blob => 0,  is_numeric => 0,  type => 'varchar(80)', default => ''},
+        Content => 
+		{read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'longtext', default => ''},
+        Headers => 
+		{read => 1, write => 1, sql_type => -4, length => 0,  is_blob => 1,  is_numeric => 0,  type => 'longtext', default => ''},
+        Creator => 
+		{read => 1, auto => 1, sql_type => 4, length => 11,  is_blob => 0,  is_numeric => 1,  type => 'int(11)', default => '0'},
+        Created => 
+		{read => 1, auto => 1, sql_type => 11, length => 0,  is_blob => 0,  is_numeric => 0,  type => 'datetime', default => ''},
+
+ }
+};
+
+RT::Base->_ImportOverlays();
+
+=head1 SEE ALSO
+
+This class allows "overlay" methods to be placed
+into the following files _Overlay is for a System overlay by the original author,
+_Vendor is for 3rd-party vendor add-ons, while _Local is for site-local customizations.  
+
+These overlay files can contain new subs or subs to replace existing subs in this module.
+
+Each of these files should begin with the line 
+
+   no warnings qw(redefine);
+
+so that perl does not kick and scream when you redefine a subroutine or variable in your overlay.
+
+RT::Attachment_Overlay, RT::Attachment_Vendor, RT::Attachment_Local
+
+=cut
+
 
 1;