rt/lib/RT/Reminders.pm

   1 # BEGIN BPS TAGGED BLOCK {{{
   2 #
   3 # COPYRIGHT:
   4 #
   5 # This software is Copyright (c) 1996-2007 Best Practical Solutions, LLC
   6 #                                          <jesse@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/copyleft/gpl.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 package RT::Reminders;
  49
  50 use base qw/RT::Base/;
  51
  52 our $REMINDER_QUEUE = 'General';
  53
  54
  55 sub new {
  56     my $class = shift;
  57     my $self = {};
  58     bless $self, $class;
  59     $self->CurrentUser(@_);
  60     return($self);
  61 }
  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
  80 =head2 Collection
  81
  82 Returns an RT::Tickets object containing reminders for this object's "Ticket"
  83
  84 =cut
  85
  86 sub Collection {
  87     my $self = shift;
  88     my $col = RT::Tickets->new($self->CurrentUser);
  89
  90      my $query =     'Queue = "'. $self->TicketObj->QueueObj->Name .'" AND Type = "reminder"';
  91     $query .= ' AND RefersTo = "'.$self->Ticket.'"';
  92
  93     $col->FromSQL($query);
  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
 109 =cut
 110
 111
 112 sub Add {
 113     my $self = shift;
 114     my %args = ( Subject => undef,
 115                  Owner => undef,
 116                  Due => undef,
 117                  @_);
 118
 119     my $reminder = RT::Ticket->new($self->CurrentUser);
 120     $reminder->Create( Subject => $args{'Subject'},
 121                        Owner => $args{'Owner'},
 122                        Due => $args{'Due'},
 123                        RefersTo => $self->Ticket,
 124                        Type => 'reminder',
 125                        Queue => $self->TicketObj->Queue,
 126
 127                    );
 128     $self->TicketObj->_NewTransaction(Type => 'AddReminder',
 129                                     Field => 'RT::Ticket',
 130                                    NewValue => $reminder->id);
 131
 132
 133 }
 134
 135
 136 sub Open {
 137     my $self = shift;
 138     my $reminder = shift;
 139
 140     $reminder->SetStatus('open');
 141     $self->TicketObj->_NewTransaction(Type => 'OpenReminder',
 142                                     Field => 'RT::Ticket',
 143                                    NewValue => $reminder->id);
 144 }
 145
 146
 147 sub Resolve {
 148     my $self = shift;
 149     my $reminder = shift;
 150     $reminder->SetStatus('resolved');
 151     $self->TicketObj->_NewTransaction(Type => 'ResolveReminder',
 152                                     Field => 'RT::Ticket',
 153                                    NewValue => $reminder->id);
 154 }
 155
 156     eval "require RT::Reminders_Vendor";
 157         if ($@ && $@ !~ qr{^Can't locate RT/Reminders_Vendor.pm}) {
 158             die $@;
 159         };
 160
 161         eval "require RT::Reminders_Local";
 162         if ($@ && $@ !~ qr{^Can't locate RT/Reminders_Local.pm}) {
 163             die $@;
 164         };
 165
 166
 167 1;