mirror of
https://github.com/pragma-/pbot.git
synced 2024-12-24 19:52:34 +01:00
245 lines
7.5 KiB
Perl
245 lines
7.5 KiB
Perl
# File: Users.pm
|
|
#
|
|
# Purpose: Manages list of bot users/admins and their metadata.
|
|
|
|
# SPDX-FileCopyrightText: 2021 Pragmatic Software <pragma78@gmail.com>
|
|
# SPDX-License-Identifier: MIT
|
|
|
|
package PBot::Core::Users;
|
|
use parent 'PBot::Core::Class';
|
|
|
|
use PBot::Imports;
|
|
|
|
sub initialize {
|
|
my ($self, %conf) = @_;
|
|
|
|
$self->{storage} = PBot::Core::Storage::HashObject->new(
|
|
pbot => $conf{pbot},
|
|
name => 'Users',
|
|
filename => $conf{filename},
|
|
);
|
|
|
|
$self->{user_index} = {};
|
|
$self->{user_cache} = {};
|
|
|
|
$self->load;
|
|
}
|
|
|
|
sub add_user {
|
|
my ($self, $name, $channels, $hostmasks, $capabilities, $password, $dont_save) = @_;
|
|
$channels = 'global' if $channels !~ m/^#/;
|
|
|
|
$capabilities //= 'none';
|
|
$password //= $self->{pbot}->random_nick(16);
|
|
|
|
my $data = {
|
|
channels => $channels,
|
|
hostmasks => $hostmasks,
|
|
password => $password
|
|
};
|
|
|
|
foreach my $cap (split /\s*,\s*/, lc $capabilities) {
|
|
next if $cap eq 'none';
|
|
$data->{$cap} = 1;
|
|
}
|
|
|
|
$self->{pbot}->{logger}->log("Adding new user (caps: $capabilities): name: $name hostmasks: $hostmasks channels: $channels\n");
|
|
$self->{storage}->add($name, $data, $dont_save);
|
|
$self->rebuild_user_index;
|
|
return $data;
|
|
}
|
|
|
|
sub remove_user {
|
|
my ($self, $name) = @_;
|
|
my $result = $self->{storage}->remove($name);
|
|
$self->rebuild_user_index;
|
|
return $result;
|
|
}
|
|
|
|
sub load {
|
|
my $self = shift;
|
|
|
|
$self->{storage}->load;
|
|
$self->rebuild_user_index;
|
|
|
|
my $i = 0;
|
|
foreach my $name (sort $self->{storage}->get_keys) {
|
|
$i++;
|
|
my $password = $self->{storage}->get_data($name, 'password');
|
|
my $channels = $self->{storage}->get_data($name, 'channels');
|
|
my $hostmasks = $self->{storage}->get_data($name, 'hostmasks');
|
|
if (not defined $channels or not defined $hostmasks or not defined $password) {
|
|
Carp::croak "User $name is missing critical data\n";
|
|
}
|
|
}
|
|
$self->{pbot}->{logger}->log(" $i users loaded.\n");
|
|
}
|
|
|
|
sub save {
|
|
my ($self) = @_;
|
|
$self->{storage}->save;
|
|
}
|
|
|
|
sub rebuild_user_index {
|
|
my ($self) = @_;
|
|
|
|
$self->{user_index} = {};
|
|
$self->{user_cache} = {};
|
|
|
|
foreach my $name ($self->{storage}->get_keys) {
|
|
my $channels = $self->{storage}->get_data($name, 'channels');
|
|
my $hostmasks = $self->{storage}->get_data($name, 'hostmasks');
|
|
|
|
my @c = split /\s*,\s*/, $channels;
|
|
my @h = split /\s*,\s*/, $hostmasks;
|
|
|
|
foreach my $channel (@c) {
|
|
foreach my $hostmask (@h) {
|
|
$self->{user_index}->{lc $channel}->{lc $hostmask} = $name;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
sub cache_user {
|
|
my ($self, $channel, $hostmask, $username, $account_mask) = @_;
|
|
return if not length $username or not length $account_mask;
|
|
$self->{user_cache}->{lc $channel}->{lc $hostmask} = [ $username, $account_mask ];
|
|
}
|
|
|
|
sub decache_user {
|
|
my ($self, $channel, $hostmask) = @_;
|
|
my $lc_channel = lc $channel;
|
|
my $lc_hostmask = lc $hostmask;
|
|
delete $self->{user_cache}->{$lc_channel}->{$lc_hostmask} if exists $self->{user_cache}->{$lc_channel};
|
|
delete $self->{user_cache}->{global}->{$lc_hostmask};
|
|
}
|
|
|
|
sub find_user_account {
|
|
my ($self, $channel, $hostmask, $any_channel) = @_;
|
|
$channel = lc $channel;
|
|
$hostmask = lc $hostmask;
|
|
$any_channel //= 0;
|
|
|
|
# first try to find an exact match
|
|
|
|
if (exists $self->{user_cache}->{$channel} and exists $self->{user_cache}->{$channel}->{$hostmask}) {
|
|
my ($username, $account_mask) = @{$self->{user_cache}->{$channel}->{$hostmask}};
|
|
return ($channel, $account_mask);
|
|
}
|
|
|
|
if (exists $self->{user_cache}->{global} and exists $self->{user_cache}->{global}->{$hostmask}) {
|
|
my ($username, $account_mask) = @{$self->{user_cache}->{global}->{$hostmask}};
|
|
return ('global', $account_mask);
|
|
}
|
|
|
|
if (exists $self->{user_index}->{$channel} and exists $self->{user_index}->{$channel}->{$hostmask}) {
|
|
return ($channel, $hostmask);
|
|
}
|
|
|
|
if (exists $self->{user_index}->{global} and exists $self->{user_index}->{global}->{$hostmask}) {
|
|
return ('global', $hostmask);
|
|
}
|
|
|
|
# no exact matches found -- check for wildcard matches
|
|
|
|
my @search_channels;
|
|
|
|
if ($any_channel) {
|
|
@search_channels = keys %{$self->{user_index}};
|
|
} else {
|
|
@search_channels = ($channel, 'global');
|
|
}
|
|
|
|
foreach my $search_channel (@search_channels) {
|
|
if (exists $self->{user_index}->{$search_channel}) {
|
|
foreach my $mask (keys %{$self->{user_index}->{$search_channel}}) {
|
|
my $mask_quoted = quotemeta $mask;
|
|
$mask_quoted =~ s/\\\*/.*?/g;
|
|
$mask_quoted =~ s/\\\?/./g;
|
|
if ($hostmask =~ m/^$mask_quoted$/i) {
|
|
return ($search_channel, $mask);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return (undef, $hostmask);
|
|
}
|
|
|
|
sub find_user {
|
|
my ($self, $channel, $hostmask, $any_channel) = @_;
|
|
$any_channel //= 0;
|
|
my ($found_channel, $found_hostmask) = $self->find_user_account($channel, $hostmask, $any_channel);
|
|
return undef if not defined $found_channel;
|
|
my $name = $self->{user_index}->{$found_channel}->{$found_hostmask};
|
|
$self->cache_user($found_channel, $hostmask, $name, $found_hostmask);
|
|
return wantarray ? ($self->{storage}->get_data($name), $name) : $self->{storage}->get_data($name);
|
|
}
|
|
|
|
sub find_admin {
|
|
my ($self, $from, $hostmask) = @_;
|
|
my $user = $self->find_user($from, $hostmask);
|
|
return undef if not defined $user;
|
|
return undef if not $self->{pbot}->{capabilities}->userhas($user, 'admin');
|
|
return $user;
|
|
}
|
|
|
|
sub login {
|
|
my ($self, $channel, $hostmask, $password) = @_;
|
|
my $user = $self->find_user($channel, $hostmask);
|
|
my $channel_text = $channel eq 'global' ? '' : " for $channel";
|
|
|
|
if (not defined $user) {
|
|
$self->{pbot}->{logger}->log("Attempt to login non-existent $channel $hostmask failed\n");
|
|
return "You do not have a user account$channel_text.";
|
|
}
|
|
|
|
if (defined $password and $user->{password} ne $password) {
|
|
$self->{pbot}->{logger}->log("Bad login password for $channel $hostmask\n");
|
|
return "I don't think so.";
|
|
}
|
|
|
|
$user->{loggedin} = 1;
|
|
my ($user_chan, $user_hostmask) = $self->find_user_account($channel, $hostmask);
|
|
my $name = $self->{user_index}->{$user_chan}->{$user_hostmask};
|
|
$self->{pbot}->{logger}->log("$hostmask logged into " . $self->{storage}->get_key_name($name) . " ($hostmask)$channel_text.\n");
|
|
return "Logged into " . $self->{storage}->get_key_name($name) . " ($hostmask)$channel_text.";
|
|
}
|
|
|
|
sub logout {
|
|
my ($self, $channel, $hostmask) = @_;
|
|
my $user = $self->find_user($channel, $hostmask);
|
|
delete $user->{loggedin} if defined $user;
|
|
}
|
|
|
|
sub loggedin {
|
|
my ($self, $channel, $hostmask) = @_;
|
|
my $user = $self->find_user($channel, $hostmask);
|
|
return $user if defined $user and $user->{loggedin};
|
|
return undef;
|
|
}
|
|
|
|
sub loggedin_admin {
|
|
my ($self, $channel, $hostmask) = @_;
|
|
my $user = $self->loggedin($channel, $hostmask);
|
|
return $user if defined $user and $self->{pbot}->{capabilities}->userhas($user, 'admin');
|
|
return undef;
|
|
}
|
|
|
|
sub get_user_metadata {
|
|
my ($self, $channel, $hostmask, $key) = @_;
|
|
my $user = $self->find_user($channel, $hostmask, 1);
|
|
return $user->{lc $key} if $user;
|
|
return undef;
|
|
}
|
|
|
|
sub get_loggedin_user_metadata {
|
|
my ($self, $channel, $hostmask, $key) = @_;
|
|
my $user = $self->loggedin($channel, $hostmask);
|
|
return $user->{lc $key} if $user;
|
|
return undef;
|
|
}
|
|
|
|
1;
|