mirror of
https://github.com/pragma-/pbot.git
synced 2024-12-28 21:52:35 +01:00
405 lines
11 KiB
Perl
405 lines
11 KiB
Perl
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
package PBot::Plugins::RemindMe;
|
|
|
|
use warnings;
|
|
use strict;
|
|
|
|
use feature 'switch';
|
|
no if $] >= 5.018, warnings => "experimental::smartmatch";
|
|
|
|
use Carp ();
|
|
use DBI;
|
|
use Time::Duration qw/concise duration/;
|
|
use Time::HiRes qw/gettimeofday/;
|
|
use Getopt::Long qw(GetOptionsFromString);
|
|
use PBot::Utils::ParseDate;
|
|
|
|
Getopt::Long::Configure ("bundling");
|
|
|
|
sub new {
|
|
Carp::croak("Options to " . __FILE__ . " should be key/value pairs, not hash reference") if ref $_[1] eq 'HASH';
|
|
my ($class, %conf) = @_;
|
|
my $self = bless {}, $class;
|
|
$self->initialize(%conf);
|
|
return $self;
|
|
}
|
|
|
|
sub initialize {
|
|
my ($self, %conf) = @_;
|
|
|
|
$self->{pbot} = delete $conf{pbot} // Carp::croak("Missing pbot reference to " . __FILE__);
|
|
|
|
$self->{pbot}->{commands}->register(sub { $self->remindme(@_) }, 'remindme', 0);
|
|
|
|
$self->{filename} = $self->{pbot}->{registry}->get_value('general', 'data_dir') . '/reminders.sqlite3';
|
|
|
|
$self->{pbot}->{timer}->register(sub { $self->check_reminders(@_) }, 1, 'RemindMe');
|
|
|
|
$self->dbi_begin;
|
|
$self->create_database;
|
|
}
|
|
|
|
sub unload {
|
|
my $self = shift;
|
|
|
|
$self->dbi_end;
|
|
|
|
$self->{pbot}->{commands}->unregister('remindme');
|
|
$self->{pbot}->{timer}->unregister('RemindMe');
|
|
}
|
|
|
|
sub create_database {
|
|
my $self = shift;
|
|
|
|
return if not $self->{dbh};
|
|
|
|
eval {
|
|
$self->{dbh}->do(<<SQL);
|
|
CREATE TABLE IF NOT EXISTS Reminders (
|
|
id INTEGER PRIMARY KEY,
|
|
account TEXT,
|
|
target TEXT,
|
|
text TEXT,
|
|
alarm NUMERIC,
|
|
repeat INTEGER,
|
|
duration NUMERIC,
|
|
created_on NUMERIC,
|
|
created_by TEXT
|
|
)
|
|
SQL
|
|
};
|
|
|
|
$self->{pbot}->{logger}->log("RemindMe: create database failed: $@") if $@;
|
|
}
|
|
|
|
sub dbi_begin {
|
|
my ($self) = @_;
|
|
eval {
|
|
$self->{dbh} = DBI->connect("dbi:SQLite:dbname=$self->{filename}", "", "", { RaiseError => 1, PrintError => 0, AutoInactiveDestroy => 1 }) or die $DBI::errstr;
|
|
};
|
|
|
|
if ($@) {
|
|
$self->{pbot}->{logger}->log("Error opening RemindMe database: $@");
|
|
delete $self->{dbh};
|
|
return 0;
|
|
} else {
|
|
return 1;
|
|
}
|
|
}
|
|
|
|
sub dbi_end {
|
|
my ($self) = @_;
|
|
return if not $self->{dbh};
|
|
$self->{dbh}->disconnect;
|
|
delete $self->{dbh};
|
|
}
|
|
|
|
sub add_reminder {
|
|
my ($self, $account, $target, $text, $alarm, $duration, $repeat, $owner) = @_;
|
|
|
|
eval {
|
|
my $sth = $self->{dbh}->prepare('INSERT INTO Reminders (account, target, text, alarm, duration, repeat, created_on, created_by) VALUES (?, ?, ?, ?, ?, ?, ?, ?)');
|
|
$sth->execute($account, $target, $text, $alarm, $duration, $repeat, scalar gettimeofday, $owner);
|
|
};
|
|
|
|
if ($@) {
|
|
$self->{pbot}->{logger}->log("Add reminder failed: $@");
|
|
return 0;
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
sub update_reminder {
|
|
my ($self, $id, $data) = @_;
|
|
|
|
|
|
eval {
|
|
my $sql = 'UPDATE Reminders SET ';
|
|
|
|
my $comma = '';
|
|
foreach my $key (keys %$data) {
|
|
$sql .= "$comma$key = ?";
|
|
$comma = ', ';
|
|
}
|
|
|
|
$sql .= ' WHERE id = ?';
|
|
|
|
my $sth = $self->{dbh}->prepare($sql);
|
|
|
|
my $param = 1;
|
|
foreach my $key (keys %$data) {
|
|
$sth->bind_param($param++, $data->{$key});
|
|
}
|
|
|
|
$sth->bind_param($param++, $id);
|
|
$sth->execute();
|
|
};
|
|
$self->{pbot}->{logger}->log($@) if $@;
|
|
}
|
|
|
|
sub get_reminder {
|
|
my ($self, $id) = @_;
|
|
|
|
my $reminder = eval {
|
|
my $sth = $self->{dbh}->prepare('SELECT * FROM Reminders WHERE id = ?');
|
|
$sth->execute($id);
|
|
return $sth->fetchrow_hashref();
|
|
};
|
|
|
|
if ($@) {
|
|
$self->{pbot}->{logger}->log("List reminders failed: $@");
|
|
return undef;
|
|
}
|
|
|
|
return $reminder;
|
|
}
|
|
|
|
sub get_reminders {
|
|
my ($self, $account) = @_;
|
|
|
|
my $reminders = eval {
|
|
my $sth = $self->{dbh}->prepare('SELECT * FROM Reminders WHERE account = ? ORDER BY id');
|
|
$sth->execute($account);
|
|
return $sth->fetchall_arrayref({});
|
|
};
|
|
|
|
if ($@) {
|
|
$self->{pbot}->{logger}->log("List reminders failed: $@");
|
|
return [];
|
|
}
|
|
|
|
return $reminders;
|
|
}
|
|
|
|
sub delete_reminder {
|
|
my ($self, $id) = @_;
|
|
return if not $self->{dbh};
|
|
|
|
eval {
|
|
my $sth = $self->{dbh}->prepare('DELETE FROM Reminders WHERE id = ?');
|
|
$sth->execute($id);
|
|
};
|
|
|
|
if ($@) {
|
|
$self->{pbot}->{logger}->log("Delete reminder $id failed: $@");
|
|
return 0;
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
sub remindme {
|
|
my ($self, $from, $nick, $user, $host, $arguments) = @_;
|
|
|
|
if (not $self->{dbh}) {
|
|
return "Internal error.";
|
|
}
|
|
|
|
my $usage = "Usage: remindme [-c channel] [-r count] message -t time | remindme -l [nick] | remindme -d id";
|
|
|
|
return $usage if not length $arguments;
|
|
|
|
my ($target, $repeat, $text, $alarm, $list_reminders, $delete_id);
|
|
|
|
my $getopt_error;
|
|
local $SIG{__WARN__} = sub {
|
|
$getopt_error = shift;
|
|
chomp $getopt_error;
|
|
};
|
|
|
|
$arguments =~ s/(?<!\\)'/\\'/g;
|
|
my ($ret, $args) = GetOptionsFromString($arguments,
|
|
'r:i' => \$repeat,
|
|
't:s' => \$alarm,
|
|
'c:s' => \$target,
|
|
'm:s' => \$text,
|
|
'l:s' => \$list_reminders,
|
|
'd:i' => \$delete_id);
|
|
|
|
return "$getopt_error -- $usage" if defined $getopt_error;
|
|
|
|
if (defined $list_reminders) {
|
|
my $nick_override = $list_reminders if length $list_reminders;
|
|
my $account;
|
|
if ($nick_override) {
|
|
my $hostmask;
|
|
($account, $hostmask) = $self->{pbot}->{messagehistory}->{database}->find_message_account_by_nick($nick_override);
|
|
|
|
if (not $account) {
|
|
return "I don't know anybody named $nick_override.";
|
|
}
|
|
|
|
($nick_override) = $hostmask =~ m/^([^!]+)!/;
|
|
} else {
|
|
$account = $self->{pbot}->{messagehistory}->{database}->get_message_account($nick, $user, $host);
|
|
}
|
|
$account = $self->{pbot}->{messagehistory}->{database}->get_ancestor_id($account);
|
|
|
|
my $reminders = $self->get_reminders($account);
|
|
my $count = 0;
|
|
my $text = '';
|
|
my $now = scalar gettimeofday;
|
|
|
|
foreach my $reminder (@$reminders) {
|
|
my $duration = concise duration $reminder->{alarm} - $now;
|
|
$text .= "$reminder->{id}) [in $duration]";
|
|
$text .= " ($reminder->{repeat} repeats left)" if $reminder->{repeat};
|
|
$text .= " $reminder->{text}\n";
|
|
$count++;
|
|
}
|
|
|
|
if (not $count) {
|
|
if ($nick_override) {
|
|
return "$nick_override has no reminders.";
|
|
} else {
|
|
return "You have no reminders.";
|
|
}
|
|
}
|
|
|
|
$reminders = $count == 1 ? 'reminder' : 'reminders';
|
|
return "$count $reminders: $text";
|
|
}
|
|
|
|
if ($delete_id) {
|
|
my $admininfo = $self->{pbot}->{admins}->loggedin($target ? $target : $from, "$nick!$user\@$host");
|
|
|
|
# admins can delete any reminders (perhaps check admin levels against owner level?)
|
|
if ($admininfo) {
|
|
if (not $self->get_reminder($delete_id)) {
|
|
return "Reminder $delete_id does not exist.";
|
|
}
|
|
|
|
if ($self->delete_reminder($delete_id)) {
|
|
return "Reminder $delete_id deleted.";
|
|
} else {
|
|
return "Could not delete reminder $delete_id.";
|
|
}
|
|
}
|
|
|
|
my $account = $self->{pbot}->{messagehistory}->{database}->get_message_account($nick, $user, $host);
|
|
$account = $self->{pbot}->{messagehistory}->{database}->get_ancestor_id($account);
|
|
my $reminder = $self->get_reminder($delete_id);
|
|
|
|
if (not $reminder) {
|
|
return "Reminder $delete_id does not exist.";
|
|
}
|
|
|
|
if ($reminder->{account} != $account) {
|
|
return "Reminder $delete_id does not belong to you.";
|
|
}
|
|
|
|
if ($self->delete_reminder($delete_id)) {
|
|
return "Reminder $delete_id deleted.";
|
|
} else {
|
|
return "Could not delete reminder $delete_id.";
|
|
}
|
|
}
|
|
|
|
$text = join ' ', @$args if not defined $text;
|
|
|
|
return "Please specify a point in time for this reminder." if not $alarm;
|
|
return "Please specify a reminder message." if not $text;
|
|
|
|
my $admininfo = $self->{pbot}->{admins}->loggedin($target ? $target : $from, "$nick!$user\@$host");
|
|
|
|
if ($target) {
|
|
if (not defined $admininfo) {
|
|
return "Only admins can create channel reminders.";
|
|
}
|
|
|
|
if (not $self->{pbot}->{channels}->is_active($target)) {
|
|
return "I'm not active in channel $target.";
|
|
}
|
|
}
|
|
|
|
my ($length, $error) = parsedate($alarm);
|
|
return $error if $error;
|
|
|
|
# I don't know how I feel about enforcing arbitrary time restrictions
|
|
if ($length > 31536000 * 10) {
|
|
return "Come on now, I'll be dead by then.";
|
|
}
|
|
|
|
if (not defined $admininfo and $length < 60) {
|
|
return "Time must be a minimum of 60 seconds.";
|
|
}
|
|
|
|
if (not defined $admininfo and $repeat > 10) {
|
|
return "You may only set up to 10 repeats.";
|
|
}
|
|
|
|
if ($repeat < 0) {
|
|
return "Repeats must be 0 or greater.";
|
|
}
|
|
|
|
$alarm = gettimeofday + $length;
|
|
|
|
my $account = $self->{pbot}->{messagehistory}->{database}->get_message_account($nick, $user, $host);
|
|
$account = $self->{pbot}->{messagehistory}->{database}->get_ancestor_id($account);
|
|
|
|
if (not defined $admininfo) {
|
|
my $reminders = $self->get_reminders($account);
|
|
if (@$reminders >= 3) {
|
|
return "You may only set 3 reminders at a time. Use `remindme -d id` to remove a reminder.";
|
|
}
|
|
}
|
|
|
|
if ($self->add_reminder($account, $target, $text, $alarm, $length, $repeat, "$nick!$user\@$host")) {
|
|
return "Reminder added.";
|
|
} else {
|
|
return "Failed to add reminder.";
|
|
}
|
|
}
|
|
|
|
sub check_reminders {
|
|
my $self = shift;
|
|
|
|
return if not $self->{dbh};
|
|
|
|
my $reminders = eval {
|
|
my $sth = $self->{dbh}->prepare('SELECT * FROM Reminders WHERE alarm <= ?');
|
|
$sth->execute(scalar gettimeofday);
|
|
return $sth->fetchall_arrayref({});
|
|
};
|
|
|
|
if ($@) {
|
|
$self->{pbot}->{logger}->log("Check reminders failed: $@");
|
|
return;
|
|
}
|
|
|
|
foreach my $reminder (@$reminders) {
|
|
# ensures we get the current nick of the person
|
|
my $hostmask = $self->{pbot}->{messagehistory}->{database}->find_most_recent_hostmask($reminder->{account});
|
|
my ($nick) = $hostmask =~ /^([^!]+)!/;
|
|
|
|
# delete this reminder if it's expired by 31 days
|
|
if (gettimeofday - $reminder->{alarm} >= 86400 * 31) {
|
|
$self->{pbot}->{logger}->log("Deleting expired reminder: $reminder->{id}) $reminder->{text} set by $reminder->{created_by}\n");
|
|
$self->delete_reminder($reminder->{id});
|
|
next;
|
|
}
|
|
|
|
# don't execute this reminder if the person isn't around yet
|
|
next if not $self->{pbot}->{nicklist}->is_present_any_channel($nick);
|
|
|
|
my $text = "Reminder: $reminder->{text}";
|
|
my $target = $reminder->{target} // $nick;
|
|
$self->{pbot}->{conn}->privmsg($target, $text);
|
|
|
|
$self->{pbot}->{logger}->log("Reminded $target about \"$text\"\n");
|
|
|
|
if ($reminder->{repeat} > 0) {
|
|
$reminder->{repeat}--;
|
|
$reminder->{alarm} = gettimeofday + $reminder->{duration};
|
|
my $data = { repeat => $reminder->{repeat}, alarm => $reminder->{alarm} };
|
|
$self->update_reminder($reminder->{id}, $data);
|
|
} else {
|
|
$self->delete_reminder($reminder->{id});
|
|
}
|
|
}
|
|
}
|
|
|
|
1;
|