Upgrade to 4.2.8
[usit-rt.git] / lib / RT / Reminders.pm
CommitLineData
84fb5b46
MKG
1# BEGIN BPS TAGGED BLOCK {{{
2#
3# COPYRIGHT:
4#
3ffc5f4f 5# This software is Copyright (c) 1996-2014 Best Practical Solutions, LLC
84fb5b46
MKG
6# <sales@bestpractical.com>
7#
8# (Except where explicitly superseded by other copyright notices)
9#
10#
11# LICENSE:
12#
13# This work is made available to you under the terms of Version 2 of
14# the GNU General Public License. A copy of that license should have
15# been provided with this software, but in any event can be snarfed
16# from www.gnu.org.
17#
18# This work is distributed in the hope that it will be useful, but
19# WITHOUT ANY WARRANTY; without even the implied warranty of
20# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21# General Public License for more details.
22#
23# You should have received a copy of the GNU General Public License
24# along with this program; if not, write to the Free Software
25# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26# 02110-1301 or visit their web page on the internet at
27# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
28#
29#
30# CONTRIBUTION SUBMISSION POLICY:
31#
32# (The following paragraph is not intended to limit the rights granted
33# to you to modify and distribute this software under the terms of
34# the GNU General Public License and is only of importance to you if
35# you choose to contribute your changes and enhancements to the
36# community by submitting them to Best Practical Solutions, LLC.)
37#
38# By intentionally submitting any modifications, corrections or
39# derivatives to this work, or any other work intended for use with
40# Request Tracker, to Best Practical Solutions, LLC, you confirm that
41# you are the copyright holder for those contributions and you grant
42# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
43# royalty-free, perpetual, license to use, copy, create derivative
44# works based on those contributions, and sublicense and distribute
45# those contributions and any derivatives thereof.
46#
47# END BPS TAGGED BLOCK }}}
48
49package RT::Reminders;
50
51use strict;
52use warnings;
53
54use base 'RT::Base';
55
56sub new {
57 my $class = shift;
58 my $self = {};
59 bless $self, $class;
60 $self->CurrentUser(@_);
61 return($self);
62}
63
64sub Ticket {
65 my $self = shift;
66 $self->{'_ticket'} = shift if (@_);
67 return ($self->{'_ticket'});
68}
69
70sub TicketObj {
71 my $self = shift;
72 unless ($self->{'_ticketobj'}) {
73 $self->{'_ticketobj'} = RT::Ticket->new($self->CurrentUser);
74 $self->{'_ticketobj'}->Load($self->Ticket);
75 }
76 return $self->{'_ticketobj'};
77}
78
79=head2 Collection
80
81Returns an RT::Tickets object containing reminders for this object's "Ticket"
82
83=cut
84
85sub Collection {
86 my $self = shift;
87 my $col = RT::Tickets->new($self->CurrentUser);
88
89 my $query = 'Type = "reminder" AND RefersTo = "'.$self->Ticket.'"';
90
91 $col->FromSQL($query);
92
3ffc5f4f
MKG
93 $col->OrderByCols( { FIELD => 'Due' }, { FIELD => 'id' } );
94
84fb5b46
MKG
95 return($col);
96}
97
98=head2 Add
99
100Add a reminder for this ticket.
101
102Takes
103
104 Subject
105 Owner
106 Due
107
108=cut
109
110sub Add {
111 my $self = shift;
112 my %args = (
113 Subject => undef,
114 Owner => undef,
115 Due => undef,
116 @_
117 );
118
c36a7e1d
MKG
119 my $ticket = RT::Ticket->new($self->CurrentUser);
120 $ticket->Load($self->Ticket);
121 if ( !$ticket->id ) {
122 return ( 0, $self->loc( "Failed to load ticket [_1]", $self->Ticket ) );
123 }
124
01e3b242 125 if ( lc $ticket->Status eq 'deleted' ) {
c36a7e1d
MKG
126 return ( 0, $self->loc("Can't link to a deleted ticket") );
127 }
128
3ffc5f4f
MKG
129 return ( 0, $self->loc('Permission Denied') )
130 unless $self->CurrentUser->HasRight(
131 Right => 'CreateTicket',
132 Object => $self->TicketObj->QueueObj,
133 )
134 && $self->CurrentUser->HasRight(
135 Right => 'ModifyTicket',
136 Object => $self->TicketObj,
137 );
138
84fb5b46 139 my $reminder = RT::Ticket->new($self->CurrentUser);
3ffc5f4f
MKG
140 # the 2nd return value is txn id, which is useless here
141 my ( $status, undef, $msg ) = $reminder->Create(
84fb5b46
MKG
142 Subject => $args{'Subject'},
143 Owner => $args{'Owner'},
144 Due => $args{'Due'},
145 RefersTo => $self->Ticket,
146 Type => 'reminder',
147 Queue => $self->TicketObj->Queue,
3ffc5f4f 148 Status => $self->TicketObj->QueueObj->LifecycleObj->ReminderStatusOnOpen,
84fb5b46
MKG
149 );
150 $self->TicketObj->_NewTransaction(
151 Type => 'AddReminder',
152 Field => 'RT::Ticket',
153 NewValue => $reminder->id
154 ) if $status;
155 return ( $status, $msg );
156}
157
158sub Open {
159 my $self = shift;
160 my $reminder = shift;
161
b5747ff2 162 my ( $status, $msg ) =
3ffc5f4f 163 $reminder->SetStatus( $reminder->LifecycleObj->ReminderStatusOnOpen );
84fb5b46
MKG
164 $self->TicketObj->_NewTransaction(
165 Type => 'OpenReminder',
166 Field => 'RT::Ticket',
167 NewValue => $reminder->id
168 ) if $status;
169 return ( $status, $msg );
170}
171
172sub Resolve {
173 my $self = shift;
174 my $reminder = shift;
b5747ff2 175 my ( $status, $msg ) =
3ffc5f4f 176 $reminder->SetStatus( $reminder->LifecycleObj->ReminderStatusOnResolve );
84fb5b46
MKG
177 $self->TicketObj->_NewTransaction(
178 Type => 'ResolveReminder',
179 Field => 'RT::Ticket',
180 NewValue => $reminder->id
181 ) if $status;
182 return ( $status, $msg );
183}
184
185RT::Base->_ImportOverlays();
186
1871;