Dev to 4.0.11
[usit-rt.git] / lib / RT / Reminders.pm
1 # BEGIN BPS TAGGED BLOCK {{{
2 #
3 # COPYRIGHT:
4 #
5 # This software is Copyright (c) 1996-2013 Best Practical Solutions, LLC
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
49 package RT::Reminders;
50
51 use strict;
52 use warnings;
53
54 use base 'RT::Base';
55
56 sub new {
57     my $class = shift;
58     my $self = {};
59     bless $self, $class;
60     $self->CurrentUser(@_);
61     return($self);
62 }
63
64 sub Ticket {
65     my $self = shift;
66     $self->{'_ticket'} = shift if (@_);
67     return ($self->{'_ticket'});
68 }
69
70 sub 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
81 Returns an RT::Tickets object containing reminders for this object's "Ticket"
82
83 =cut
84
85 sub 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
93     $col->OrderBy( FIELD => 'Due' );
94     
95     return($col);
96 }
97
98 =head2 Add
99
100 Add a reminder for this ticket.
101
102 Takes
103
104     Subject
105     Owner
106     Due
107
108 =cut
109
110 sub Add {
111     my $self = shift;
112     my %args = (
113         Subject => undef,
114         Owner => undef,
115         Due => undef,
116         @_
117     );
118
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
125     if ( $ticket->Status eq 'deleted' ) {
126         return ( 0, $self->loc("Can't link to a deleted ticket") );
127     }
128
129     my $reminder = RT::Ticket->new($self->CurrentUser);
130     my ( $status, $msg ) = $reminder->Create(
131         Subject => $args{'Subject'},
132         Owner => $args{'Owner'},
133         Due => $args{'Due'},
134         RefersTo => $self->Ticket,
135         Type => 'reminder',
136         Queue => $self->TicketObj->Queue,
137     );
138     $self->TicketObj->_NewTransaction(
139         Type => 'AddReminder',
140         Field => 'RT::Ticket',
141         NewValue => $reminder->id
142     ) if $status;
143     return ( $status, $msg );
144 }
145
146 sub Open {
147     my $self = shift;
148     my $reminder = shift;
149
150     my ( $status, $msg ) =
151       $reminder->SetStatus( $reminder->QueueObj->Lifecycle->ReminderStatusOnOpen );
152     $self->TicketObj->_NewTransaction(
153         Type => 'OpenReminder',
154         Field => 'RT::Ticket',
155         NewValue => $reminder->id
156     ) if $status;
157     return ( $status, $msg );
158 }
159
160 sub Resolve {
161     my $self = shift;
162     my $reminder = shift;
163     my ( $status, $msg ) =
164       $reminder->SetStatus( $reminder->QueueObj->Lifecycle->ReminderStatusOnResolve );
165     $self->TicketObj->_NewTransaction(
166         Type => 'ResolveReminder',
167         Field => 'RT::Ticket',
168         NewValue => $reminder->id
169     ) if $status;
170     return ( $status, $msg );
171 }
172
173 RT::Base->_ImportOverlays();
174
175 1;