import of rt 3.0.9

[freeside.git] / rt / bin / rt-mailgate

diff --git a/rt/bin/rt-mailgate b/rt/bin/rt-mailgate
index b304436..8af8002 100755 (executable)
--- a/rt/bin/rt-mailgate
+++ b/rt/bin/rt-mailgate
@@ -1,26 +1,26 @@
 #!/usr/bin/perl -w
 # BEGIN LICENSE BLOCK
 #!/usr/bin/perl -w
 # BEGIN LICENSE BLOCK

-#
+# 

 # Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>
 # Copyright (c) 1996-2003 Jesse Vincent <jesse@bestpractical.com>

-#
+# 

 # (Except where explictly superceded by other copyright notices)
 # (Except where explictly superceded by other copyright notices)

-#
+# 

 # 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 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.
 # 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.

-#
+# 

 # 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.
 # 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.

-#
-#
+# 
+# 

 # END LICENSE BLOCK
 
 =head1 NAME
 # END LICENSE BLOCK
 
 =head1 NAME


@@ -31,10 +31,25 @@ rt-mailgate - Mail interface to RT3.
 
 use RT::I18N;
 
 
 use RT::I18N;
 

+# Make sure that when we call the mailgate wrong, it tempfails
+
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://bad.address"), "Opened the mailgate - The error below is expected - $@");
+print MAIL <<EOF;
+From: root\@localhost
+To: rt\@example.com
+Subject: This is a test of new ticket creation
+
+Foob!
+EOF
+close (MAIL);
+
+# Check the return value
+is ( $? >> 8, 75, "The error message above is expected The mail gateway exited with a failure. yay");
+

 
 # {{{ Test new ticket creation by root who is privileged and superuser
 
 
 # {{{ Test new ticket creation by root who is privileged and superuser
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action correspond"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action correspond"), "Opened the mailgate - $@");

 print MAIL <<EOF;
 From: root\@localhost
 To: rt\@example.com
 print MAIL <<EOF;
 From: root\@localhost
 To: rt\@example.com


@@ -45,6 +60,9 @@ Foob!
 EOF
 close (MAIL);
 
 EOF
 close (MAIL);
 

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");
+

 use RT::Tickets;
 my $tickets = RT::Tickets->new($RT::SystemUser);
 $tickets->OrderBy(FIELD => 'id', ORDER => 'DESC');
 use RT::Tickets;
 my $tickets = RT::Tickets->new($RT::SystemUser);
 $tickets->OrderBy(FIELD => 'id', ORDER => 'DESC');


@@ -59,7 +77,7 @@ ok ($tick->Subject eq 'This is a test of new ticket creation', "Created the tick
 
 # {{{This is a test of new ticket creation as an unknown user
 
 
 # {{{This is a test of new ticket creation as an unknown user
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action correspond"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action correspond"), "Opened the mailgate - $@");

 print MAIL <<EOF;
 From: doesnotexist\@example.com
 To: rt\@example.com
 print MAIL <<EOF;
 From: doesnotexist\@example.com
 To: rt\@example.com


@@ -69,6 +87,8 @@ Blah!
 Foob!
 EOF
 close (MAIL);
 Foob!
 EOF
 close (MAIL);

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");

 
 $tickets = RT::Tickets->new($RT::SystemUser);
 $tickets->OrderBy(FIELD => 'id', ORDER => 'DESC');
 
 $tickets = RT::Tickets->new($RT::SystemUser);
 $tickets->OrderBy(FIELD => 'id', ORDER => 'DESC');


@@ -94,7 +114,7 @@ ok ($val, "Granted everybody the right to create tickets - $msg");
 
 sleep(60); # gotta sleep so the remote process' ACL cache times out
 
 
 sleep(60); # gotta sleep so the remote process' ACL cache times out
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action correspond"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action correspond"), "Opened the mailgate - $@");

 print MAIL <<EOF;
 From: doesnotexist\@example.com
 To: rt\@example.com
 print MAIL <<EOF;
 From: doesnotexist\@example.com
 To: rt\@example.com


@@ -104,6 +124,8 @@ Blah!
 Foob!
 EOF
 close (MAIL);
 Foob!
 EOF
 close (MAIL);

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");

 
 
 $tickets = RT::Tickets->new($RT::SystemUser);
 
 
 $tickets = RT::Tickets->new($RT::SystemUser);


@@ -126,7 +148,7 @@ ok( $u->Id != 0, " user does not exist and was created by ticket submission");
 #ok ($val, "Granted everybody the right to create tickets - $msg");
 #sleep(60); # gotta sleep so the remote process' ACL cache times out
 
 #ok ($val, "Granted everybody the right to create tickets - $msg");
 #sleep(60); # gotta sleep so the remote process' ACL cache times out
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action correspond"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action correspond"), "Opened the mailgate - $@");

 print MAIL <<EOF;
 From: doesnotexist-2\@example.com
 To: rt\@example.com
 print MAIL <<EOF;
 From: doesnotexist-2\@example.com
 To: rt\@example.com


@@ -136,6 +158,8 @@ Blah!
 Foob!
 EOF
 close (MAIL);
 Foob!
 EOF
 close (MAIL);

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");

 
 $u = RT::User->new($RT::SystemUser);
 $u->Load('doesnotexist-2@example.com');
 
 $u = RT::User->new($RT::SystemUser);
 $u->Load('doesnotexist-2@example.com');


@@ -148,7 +172,7 @@ ok( $u->Id == 0, " user does not exist and was not created by ticket corresponde
 ok ($val, "Granted everybody the right to reply to  tickets - $msg");
 sleep(60); # gotta sleep so the remote process' ACL cache times out
 
 ok ($val, "Granted everybody the right to reply to  tickets - $msg");
 sleep(60); # gotta sleep so the remote process' ACL cache times out
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action correspond"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action correspond"), "Opened the mailgate - $@");

 print MAIL <<EOF;
 From: doesnotexist-2\@example.com
 To: rt\@example.com
 print MAIL <<EOF;
 From: doesnotexist-2\@example.com
 To: rt\@example.com


@@ -158,6 +182,8 @@ Blah!
 Foob!
 EOF
 close (MAIL);
 Foob!
 EOF
 close (MAIL);

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");

 
 
 $u = RT::User->new($RT::SystemUser);
 
 
 $u = RT::User->new($RT::SystemUser);


@@ -173,7 +199,7 @@ ok( $u->Id != 0, " user exists and was created by ticket correspondence submissi
 #ok ($val, "Granted everybody the right to create tickets - $msg");
 #sleep(60); # gotta sleep so the remote process' ACL cache times out
 
 #ok ($val, "Granted everybody the right to create tickets - $msg");
 #sleep(60); # gotta sleep so the remote process' ACL cache times out
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action comment"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action comment"), "Opened the mailgate - $@");

 print MAIL <<EOF;
 From: doesnotexist-3\@example.com
 To: rt\@example.com
 print MAIL <<EOF;
 From: doesnotexist-3\@example.com
 To: rt\@example.com


@@ -184,6 +210,9 @@ Foob!
 EOF
 close (MAIL);
 
 EOF
 close (MAIL);
 

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");
+

 $u = RT::User->new($RT::SystemUser);
 $u->Load('doesnotexist-3@example.com');
 ok( $u->Id == 0, " user does not exist and was not created by ticket comment submission");
 $u = RT::User->new($RT::SystemUser);
 $u->Load('doesnotexist-3@example.com');
 ok( $u->Id == 0, " user does not exist and was not created by ticket comment submission");


@@ -196,7 +225,7 @@ ok( $u->Id == 0, " user does not exist and was not created by ticket comment sub
 ok ($val, "Granted everybody the right to reply to  tickets - $msg");
 sleep(60); # gotta sleep so the remote process' ACL cache times out
 
 ok ($val, "Granted everybody the right to reply to  tickets - $msg");
 sleep(60); # gotta sleep so the remote process' ACL cache times out
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action comment"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action comment"), "Opened the mailgate - $@");

 print MAIL <<EOF;
 From: doesnotexist-3\@example.com
 To: rt\@example.com
 print MAIL <<EOF;
 From: doesnotexist-3\@example.com
 To: rt\@example.com


@@ -207,6 +236,8 @@ Foob!
 EOF
 close (MAIL);
 
 EOF
 close (MAIL);
 

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");

 
 $u = RT::User->new($RT::SystemUser);
 $u->Load('doesnotexist-3@example.com');
 
 $u = RT::User->new($RT::SystemUser);
 $u->Load('doesnotexist-3@example.com');


@@ -227,17 +258,20 @@ my $entity = MIME::Entity->build( From => 'root@localhost',
                                 Data => ['This is a test of a binary attachment']);
 
 # currently in lib/t/autogen
                                 Data => ['This is a test of a binary attachment']);
 
 # currently in lib/t/autogen

-$entity->attach(Path => '../../../html/NoAuth/images/spacer.gif', 
+$entity->attach(Path => '/opt/rt3/share/html/NoAuth/images/spacer.gif', 

                 Type => 'image/gif',
                 Encoding => 'base64');
 
 # Create a ticket with a binary attachment
                 Type => 'image/gif',
                 Encoding => 'base64');
 
 # Create a ticket with a binary attachment

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action correspond"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action correspond"), "Opened the mailgate - $@");

 
 $entity->print(\*MAIL);
 
 close (MAIL);
 
 
 $entity->print(\*MAIL);
 
 close (MAIL);
 

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");
+

 my $tickets = RT::Tickets->new($RT::SystemUser);
 $tickets->OrderBy(FIELD => 'id', ORDER => 'DESC');
 $tickets->Limit(FIELD => 'id', OPERATOR => '>', VALUE => '0');
 my $tickets = RT::Tickets->new($RT::SystemUser);
 $tickets->OrderBy(FIELD => 'id', ORDER => 'DESC');
 $tickets->Limit(FIELD => 'id', OPERATOR => '>', VALUE => '0');


@@ -273,7 +307,7 @@ use LWP::UserAgent;
 # Grab the binary attachment via the web ui
 my $ua      = LWP::UserAgent->new();
 
 # Grab the binary attachment via the web ui
 my $ua      = LWP::UserAgent->new();
 

-my $full_url = "http://localhost/Ticket/Attachment/".$attachment->TransactionId."/".$attachment->id."/spacer.gif?&user=root&pass=password";
+my $full_url = "http://localhost".$RT::WebPath."/Ticket/Attachment/".$attachment->TransactionId."/".$attachment->id."/spacer.gif?&user=root&pass=password";

 my $r = $ua->get( $full_url);
 
 
 my $r = $ua->get( $full_url);
 
 


@@ -286,7 +320,7 @@ is($file, $r->content, 'The attachment isn\'t screwed up in download');
 
 # {{{ Simple I18N testing
 
 
 # {{{ Simple I18N testing
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action correspond"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action correspond"), "Opened the mailgate - $@");

                                                                          
 print MAIL <<EOF;
 From: root\@localhost
                                                                          
 print MAIL <<EOF;
 From: root\@localhost


@@ -301,6 +335,9 @@ bye
 EOF
 close (MAIL);
 
 EOF
 close (MAIL);
 

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");
+

 my $unitickets = RT::Tickets->new($RT::SystemUser);
 $unitickets->OrderBy(FIELD => 'id', ORDER => 'DESC');
 $unitickets->Limit(FIELD => 'id', OPERATOR => '>', VALUE => '0');
 my $unitickets = RT::Tickets->new($RT::SystemUser);
 $unitickets->OrderBy(FIELD => 'id', ORDER => 'DESC');
 $unitickets->Limit(FIELD => 'id', OPERATOR => '>', VALUE => '0');


@@ -317,7 +354,7 @@ is ($unitick->Transactions->First->Content, $unitick->Transactions->First->Attac
 ok($unitick->Transactions->First->Attachments->First->Content =~ /$unistring/i, $unitick->Id." appears to be unicode ". $unitick->Transactions->First->Attachments->First->Id);
 # supposedly I18N fails on the second message sent in.
 
 ok($unitick->Transactions->First->Attachments->First->Content =~ /$unistring/i, $unitick->Id." appears to be unicode ". $unitick->Transactions->First->Attachments->First->Id);
 # supposedly I18N fails on the second message sent in.
 

-ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost/ --queue general --action correspond"), "Opened the mailgate - $@");
+ok(open(MAIL, "|/opt/rt3/bin/rt-mailgate --url http://localhost".$RT::WebPath."/ --queue general --action correspond"), "Opened the mailgate - $@");

                                                                          
 print MAIL <<EOF;
 From: root\@localhost
                                                                          
 print MAIL <<EOF;
 From: root\@localhost


@@ -332,6 +369,9 @@ bye
 EOF
 close (MAIL);
 
 EOF
 close (MAIL);
 

+#Check the return value
+is ($? >> 8, 0, "The mail gateway exited normally. yay");
+

 my $tickets2 = RT::Tickets->new($RT::SystemUser);
 $tickets2->OrderBy(FIELD => 'id', ORDER => 'DESC');
 $tickets2->Limit(FIELD => 'id', OPERATOR => '>', VALUE => '0');
 my $tickets2 = RT::Tickets->new($RT::SystemUser);
 $tickets2->OrderBy(FIELD => 'id', ORDER => 'DESC');
 $tickets2->Limit(FIELD => 'id', OPERATOR => '>', VALUE => '0');


@@ -367,7 +407,7 @@ use LWP::UserAgent;
 use constant EX_TEMPFAIL => 75;
 
 my %opts;
 use constant EX_TEMPFAIL => 75;
 
 my %opts;

-GetOptions( \%opts, "queue=s", "action=s", "url=s", "jar=s", "help", "debug", "extension=s" );
+GetOptions( \%opts, "queue=s", "action=s", "url=s", "jar=s", "help", "debug", "extension=s", "timeout=i" );

 
 if ( $opts{help} ) {
     require Pod::Usage;
 
 if ( $opts{help} ) {
     require Pod::Usage;


@@ -381,17 +421,18 @@ for (qw(url)) {
 }
 
 undef $/;
 }
 
 undef $/;

-my $message = <>;

 my $ua      = LWP::UserAgent->new();
 $ua->cookie_jar( { file => $opts{jar} } );
 
 my %args = (
     queue   => $opts{queue},
     action  => $opts{action},
 my $ua      = LWP::UserAgent->new();
 $ua->cookie_jar( { file => $opts{jar} } );
 
 my %args = (
     queue   => $opts{queue},
     action  => $opts{action},

-    message => $message,

     SessionType => 'REST',    # Surpress login box
 );
 
     SessionType => 'REST',    # Surpress login box
 );
 

+# Read the message in from STDIN
+$args{'message'} = <>;
+

 
 if ($opts{'extension'}) {
         $args{$opts{'extension'}} = $ENV{'EXTENSION'};
 
 if ($opts{'extension'}) {
         $args{$opts{'extension'}} = $ENV{'EXTENSION'};


@@ -404,6 +445,7 @@ warn "Connecting to $full_url" if $opts{'debug'};
 
 
 
 
 
 

+$ua->timeout(exists($opts{'timeout'}) ? $opts{'timeout'} : 180);

 my $r = $ua->post( $full_url, {%args} );
 check_failure($r);
 
 my $r = $ua->post( $full_url, {%args} );
 check_failure($r);
 


@@ -414,7 +456,7 @@ if ( $content !~ /^(ok|not ok)/ ) {
 
     # It's not the server's fault if the mail is bogus. We just want to know that
     # *something* came out of the server.
 
     # It's not the server's fault if the mail is bogus. We just want to know that
     # *something* came out of the server.

-    die <<EOF
+    warn <<EOF;

 RT server error.
 
 The RT server which handled your email did not behave as expected. It
 RT server error.
 
 The RT server which handled your email did not behave as expected. It


@@ -423,8 +465,13 @@ said:
 $content
 EOF
 
 $content
 EOF
 

+exit EX_TEMPFAIL;
+

 }
 
 }
 

+exit;
+
+

 sub check_failure {
     my $r = shift;
     return if $r->is_success();
 sub check_failure {
     my $r = shift;
     return if $r->is_success();


@@ -455,7 +502,11 @@ Usual invocation (from MTA):
 
     rt-mailgate --action (correspond|comment) --queue queuename
                 --url http://your.rt.server/
 
     rt-mailgate --action (correspond|comment) --queue queuename
                 --url http://your.rt.server/

-                [ --extension (queue|action|ticket)
+                [ --debug ]
+                [ --extension (queue|action|ticket) ]
+                [ --timeout seconds ]
+
+

 
 See C<man rt-mailgate> for more.
 
 
 See C<man rt-mailgate> for more.
 


@@ -486,6 +537,16 @@ submitted to will be set to the value of $EXTENSION. By specifying
 is related to.  "action" will allow the user to specify either "comment" or
 "correspond" in the address extension.
 
 is related to.  "action" will allow the user to specify either "comment" or
 "correspond" in the address extension.
 

+=item C<--debug> OPTIONAL
+
+Print debugging output to standard error
+
+
+=item C<--timeout> OPTIONAL
+
+Configure the timeout for posting the message to the web server.  The
+default timeout is 3 minutes (180 seconds).
+

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION