rt/lib/RT/Reminders.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2011 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 base qw/RT::Base/;
  52
  53 our $REMINDER_QUEUE = 'General';
  54
  55
  56 sub new {
  57     my $class = shift;
  58     my $self = {};
  59     bless $self, $class;
  60     $self->CurrentUser(@_);
  61     return($self);
  62 }
  63
  64
  65 sub Ticket {
  66     my $self = shift;
  67     $self->{'_ticket'} = shift if (@_);
  68     return ($self->{'_ticket'});
  69 }
  70
  71 sub TicketObj {
  72     my $self = shift;
  73     unless ($self->{'_ticketobj'}) {
  74         $self->{'_ticketobj'} = RT::Ticket->new($self->CurrentUser);
  75         $self->{'_ticketobj'}->Load($self->Ticket);
  76     }
  77         return $self->{'_ticketobj'};
  78 }
  79
  80
  81 =head2 Collection
  82
  83 Returns an RT::Tickets object containing reminders for this object's "Ticket"
  84
  85 =cut
  86
  87 sub Collection {
  88     my $self = shift;
  89     my $col = RT::Tickets->new($self->CurrentUser);
  90
  91      my $query = 'Type = "reminder" AND RefersTo = "'.$self->Ticket.'"';
  92
  93     $col->FromSQL($query);
  94
  95     $col->OrderBy( FIELD => 'Due' );
  96
  97     return($col);
  98 }
  99
 100 =head2 Add
 101
 102 Add a reminder for this ticket.
 103
 104 Takes
 105
 106     Subject
 107     Owner
 108     Due
 109
 110
 111 =cut
 112
 113
 114 sub Add {
 115     my $self = shift;
 116     my %args = ( Subject => undef,
 117                  Owner => undef,
 118                  Due => undef,
 119                  @_);
 120
 121     my $reminder = RT::Ticket->new($self->CurrentUser);
 122     $reminder->Create( Subject => $args{'Subject'},
 123                        Owner => $args{'Owner'},
 124                        Due => $args{'Due'},
 125                        RefersTo => $self->Ticket,
 126                        Type => 'reminder',
 127                        Queue => $self->TicketObj->Queue,
 128
 129                    );
 130     $self->TicketObj->_NewTransaction(Type => 'AddReminder',
 131                                     Field => 'RT::Ticket',
 132                                    NewValue => $reminder->id);
 133
 134
 135 }
 136
 137
 138 sub Open {
 139     my $self = shift;
 140     my $reminder = shift;
 141
 142     $reminder->SetStatus('open');
 143     $self->TicketObj->_NewTransaction(Type => 'OpenReminder',
 144                                     Field => 'RT::Ticket',
 145                                    NewValue => $reminder->id);
 146 }
 147
 148
 149 sub Resolve {
 150     my $self = shift;
 151     my $reminder = shift;
 152     $reminder->SetStatus('resolved');
 153     $self->TicketObj->_NewTransaction(Type => 'ResolveReminder',
 154                                     Field => 'RT::Ticket',
 155                                    NewValue => $reminder->id);
 156 }
 157
 158     eval "require RT::Reminders_Vendor";
 159         if ($@ && $@ !~ qr{^Can't locate RT/Reminders_Vendor.pm}) {
 160             die $@;
 161         };
 162
 163         eval "require RT::Reminders_Local";
 164         if ($@ && $@ !~ qr{^Can't locate RT/Reminders_Local.pm}) {
 165             die $@;
 166         };
 167
 168
 169 1;