summaryrefslogtreecommitdiff
path: root/rt/lib/RT/Approval
diff options
context:
space:
mode:
Diffstat (limited to 'rt/lib/RT/Approval')
-rw-r--r--rt/lib/RT/Approval/Rule.pm85
-rw-r--r--rt/lib/RT/Approval/Rule/Created.pm71
-rw-r--r--rt/lib/RT/Approval/Rule/NewPending.pm97
-rw-r--r--rt/lib/RT/Approval/Rule/Passed.pm110
-rw-r--r--rt/lib/RT/Approval/Rule/Rejected.pm114
5 files changed, 477 insertions, 0 deletions
diff --git a/rt/lib/RT/Approval/Rule.pm b/rt/lib/RT/Approval/Rule.pm
new file mode 100644
index 0000000..37ca478
--- /dev/null
+++ b/rt/lib/RT/Approval/Rule.pm
@@ -0,0 +1,85 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
+# <jesse@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 }}}
+
+package RT::Approval::Rule;
+use strict;
+use warnings;
+
+use base 'RT::Rule';
+
+use constant _Queue => '___Approvals';
+
+sub Prepare {
+ my $self = shift;
+ return unless $self->SUPER::Prepare();
+ $self->TicketObj->Type eq 'approval';
+}
+
+sub GetTemplate {
+ my ($self, $template_name, %args) = @_;
+ my $template = RT::Template->new($self->CurrentUser);
+ $template->Load($template_name) or return;
+ my ($result, $msg) = $template->Parse(%args);
+
+ # XXX: error handling
+
+ return $template;
+}
+
+eval "require RT::Approval::Rule_Vendor";
+if ($@ && $@ !~ qr{^Can't locate RT/Approval/Rule_Vendor.pm}) {
+ die $@;
+};
+
+eval "require RT::Approval::Rule_Local";
+if ($@ && $@ !~ qr{^Can't locate RT/Approval/Rule_Local.pm}) {
+ die $@;
+};
+
+1;
+
diff --git a/rt/lib/RT/Approval/Rule/Created.pm b/rt/lib/RT/Approval/Rule/Created.pm
new file mode 100644
index 0000000..73ba2db
--- /dev/null
+++ b/rt/lib/RT/Approval/Rule/Created.pm
@@ -0,0 +1,71 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
+# <jesse@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 }}}
+
+package RT::Approval::Rule::Created;
+use strict;
+use warnings;
+use base 'RT::Approval::Rule';
+
+use constant _Stage => 'TransactionBatch';
+
+use constant Description => "Notify Owner of their ticket has been approved by some or all approvers"; # loc
+
+sub Prepare {
+ my $self = shift;
+ return unless $self->SUPER::Prepare();
+
+ $self->TransactionObj->Type eq 'Create' &&
+ !$self->TicketObj->HasUnresolvedDependencies( Type => 'approval' );
+}
+
+sub Commit {
+ my $self = shift;
+ $self->RunScripAction('Open Tickets' => 'Blank');
+}
+
+1;
diff --git a/rt/lib/RT/Approval/Rule/NewPending.pm b/rt/lib/RT/Approval/Rule/NewPending.pm
new file mode 100644
index 0000000..5a6f1ed
--- /dev/null
+++ b/rt/lib/RT/Approval/Rule/NewPending.pm
@@ -0,0 +1,97 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
+# <jesse@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 }}}
+
+package RT::Approval::Rule::NewPending;
+use strict;
+use warnings;
+use base 'RT::Approval::Rule';
+
+use constant Description => "When an approval ticket is created, notify the Owner and AdminCc of the item awaiting their approval"; # loc
+
+sub Prepare {
+ my $self = shift;
+ return unless $self->SUPER::Prepare();
+
+ $self->OnStatusChange('open') and
+ eval { $T::Approving = ($self->TicketObj->AllDependedOnBy( Type => 'ticket' ))[0] }
+}
+
+sub Commit {
+ my $self = shift;
+ my ($top) = $self->TicketObj->AllDependedOnBy( Type => 'ticket' );
+ my $t = $self->TicketObj->Transactions;
+ my $to;
+ while ( my $o = $t->Next ) {
+ $to = $o, last if $o->Type eq 'Create';
+ }
+
+ # XXX: this makes the owner incorrect so notify owner won't work
+ # local $self->{TicketObj} = $top;
+
+ # first txn entry of the approval ticket
+ local $self->{TransactionObj} = $to;
+ $self->RunScripAction('Notify Owner', 'New Pending Approval', @_);
+
+ return;
+
+ # this generates more correct content of the message, but not sure
+ # if ccmessageto is the right way to do this.
+ my $template = $self->GetTemplate('New Pending Approval',
+ TicketObj => $top,
+ TransactionObj => $to)
+ or return;
+
+ my ( $result, $msg ) = $template->Parse(
+ TicketObj => $top,
+ );
+ $self->TicketObj->Comment( CcMessageTo => $self->TicketObj->OwnerObj->EmailAddress,
+ MIMEObj => $template->MIMEObj );
+
+}
+
+1;
diff --git a/rt/lib/RT/Approval/Rule/Passed.pm b/rt/lib/RT/Approval/Rule/Passed.pm
new file mode 100644
index 0000000..3134019
--- /dev/null
+++ b/rt/lib/RT/Approval/Rule/Passed.pm
@@ -0,0 +1,110 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
+# <jesse@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 }}}
+
+package RT::Approval::Rule::Passed;
+use strict;
+use warnings;
+use base 'RT::Approval::Rule';
+
+use constant Description => "Notify Owner of their ticket has been approved by some or all approvers"; # loc
+
+sub Prepare {
+ my $self = shift;
+ return unless $self->SUPER::Prepare();
+
+ $self->OnStatusChange('resolved');
+}
+
+sub Commit {
+ my $self = shift;
+ my $note;
+ my $t = $self->TicketObj->Transactions;
+
+ while ( my $o = $t->Next ) {
+ next unless $o->Type eq 'Correspond';
+ $note .= $o->Content . "\n" if $o->ContentObj;
+ }
+
+ my ($top) = $self->TicketObj->AllDependedOnBy( Type => 'ticket' );
+ my $links = $self->TicketObj->DependedOnBy;
+
+ while ( my $link = $links->Next ) {
+ my $obj = $link->BaseObj;
+ next unless $obj->Type eq 'approval';
+
+ for my $other ($obj->AllDependsOn( Type => 'approval' )) {
+ if ( $other->QueueObj->IsActiveStatus( $other->Status ) ) {
+ $other->__Set(
+ Field => 'Status',
+ Value => 'deleted',
+ );
+ }
+
+ }
+ $obj->SetStatus( Status => 'open', Force => 1 );
+ }
+
+ my $passed = !$top->HasUnresolvedDependencies( Type => 'approval' );
+ my $template = $self->GetTemplate(
+ $passed ? 'All Approvals Passed' : 'Approval Passed',
+ TicketObj => $top,
+ Approval => $self->TicketObj,
+ Notes => $note,
+ ) or die;
+
+ $top->Correspond( MIMEObj => $template->MIMEObj );
+
+ if ($passed) {
+ $self->RunScripAction('Notify Owner', 'Approval Ready for Owner',
+ TicketObj => $top);
+ }
+
+ return;
+}
+
+1;
diff --git a/rt/lib/RT/Approval/Rule/Rejected.pm b/rt/lib/RT/Approval/Rule/Rejected.pm
new file mode 100644
index 0000000..7353f63
--- /dev/null
+++ b/rt/lib/RT/Approval/Rule/Rejected.pm
@@ -0,0 +1,114 @@
+# BEGIN BPS TAGGED BLOCK {{{
+#
+# COPYRIGHT:
+#
+# This software is Copyright (c) 1996-2009 Best Practical Solutions, LLC
+# <jesse@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 }}}
+
+package RT::Approval::Rule::Rejected;
+use strict;
+use warnings;
+use base 'RT::Approval::Rule';
+
+use constant Description => "If an approval is rejected, reject the original and delete pending approvals"; # loc
+
+sub Prepare {
+ my $self = shift;
+ return unless $self->SUPER::Prepare();
+
+ return (0)
+ unless $self->OnStatusChange('rejected') or $self->OnStatusChange('deleted')
+}
+
+sub Commit { # XXX: from custom prepare code
+ my $self = shift;
+ if ( my ($rejected) =
+ $self->TicketObj->AllDependedOnBy( Type => 'ticket' ) ) {
+ my $note = '';
+ if ( RT->Config->Get('ApprovalRejectionNotes') ) {
+ my $t = $self->TicketObj->Transactions;
+ while ( my $o = $t->Next ) {
+ next unless $o->Type eq 'Correspond';
+ $note .= $o->Content . "\n" if $o->ContentObj;
+ }
+ }
+
+ my $template = $self->GetTemplate('Approval Rejected',
+ TicketObj => $rejected,
+ Approval => $self->TicketObj,
+ Notes => $note);
+
+ $rejected->Correspond( MIMEObj => $template->MIMEObj );
+ $rejected->SetStatus(
+ Status => 'rejected',
+ Force => 1,
+ );
+ }
+ my $links = $self->TicketObj->DependedOnBy;
+ foreach my $link ( @{ $links->ItemsArrayRef } ) {
+ my $obj = $link->BaseObj;
+ if ( $obj->QueueObj->IsActiveStatus( $obj->Status ) ) {
+ if ( $obj->Type eq 'approval' ) {
+ $obj->SetStatus(
+ Status => 'deleted',
+ Force => 1,
+ );
+ }
+ }
+ }
+
+ $links = $self->TicketObj->DependsOn;
+ foreach my $link ( @{ $links->ItemsArrayRef } ) {
+ my $obj = $link->TargetObj;
+ if ( $obj->QueueObj->IsActiveStatus( $obj->Status ) ) {
+ $obj->SetStatus(
+ Status => 'deleted',
+ Force => 1,
+ );
+ }
+ }
+
+}
+
+1;