From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

JSIME / App-RoboBot-4.004 / lib / App / RoboBot / Plugin / Bot / Auth.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
—
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
—
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

              
package App::RoboBot::Plugin::Bot::Auth;
$App::RoboBot::Plugin::Bot::Auth::VERSION = '4.004';
use v5.20;
use namespace::autoclean;
use Moose;
use MooseX::SetOnce;
use App::RoboBot::Nick;
extends 'App::RoboBot::Plugin';
=head1 bot.auth
Provides functions for managing authorization lists, denying and allowing
access to specific functions for specific users.
=cut
has '+name' => (
    default => 'Bot::Auth',
);
has '+description' => (
    default => 'Provides functions for managing authorization lists, denying and allowing access to specific functions for specific users.',
);
=head2 auth-default
=head3 Description
Sets the default permission mode for a function on the current network.
=head3 Usage
<function name> <"allow" | "deny">
=head3 Examples
    (auth-default set-alarm deny)
=head2 auth-allow
=head3 Description
Grants permission for a user to call the specified function.
=head3 Usage
<function name> <nick>
=head3 Examples
    (auth-allow set-alarm Beauford)
=head2 auth-deny
=head3 Description
Revokes permission for a user to the specified function.
=head3 Usage
<function name> <nick>
=head3 Examples
    (auth-allow set-alarm Beauford)
=cut
has '+commands' => (
    default => sub {{
        'auth-default' => { method      => 'auth_default',
                            description => 'Sets the default permission mode for a function. All functions are assumed to be in "allow" mode unless set otherwise.',
                            usage       => '<function name> <allow | deny>' },
        'auth-allow' => { method      => 'auth_modify',
                          description => 'Marks the given nick as explicitly permitted to call the named function, even if the function is by default denied to all users.',
                          usage       => '<function name> <nick>' },
        'auth-deny' => { method      => 'auth_modify',
                         description => 'Explicitly blocks the given nick from calling the named function.',
                         usage       => '<function name> <nick>' },
    }},
);
sub auth_default {
    my ($self, $message, $command, $rpl, $function_name, $mode) = @_;
    unless (defined $function_name && defined $mode) {
        $message->response->raise('Must provide a function name and permission mode.');
        return;
    }
    $mode = lc($mode);
    unless ($mode eq 'allow' or $mode eq 'deny') {
        $message->response->raise('Only valid permission modes are "allow" and "deny".');
        return;
    }
    unless (exists $self->bot->commands->{lc($function_name)}) {
        $message->response->raise('The function "%s" is not known.', $function_name);
        return;
    }
    my $res = $self->bot->config->db->do(q{
        update auth_permissions
        set ???
        where network_id = ? and lower(command) = lower(?)
    }, { state => $mode, granted_by => $message->sender->id }, $message->network->id, $function_name);
    unless ($res && $res->count > 0) {
        $res = $self->bot->config->db->do(q{
            insert into auth_permissions ???
        }, {
            network_id => $message->network->id,
            command    => lc($function_name),
            state      => $mode,
            granted_by => $message->sender->id,
        });
    }
    $message->response->push(sprintf('Default permission for function "%s" have been set to: %s.', $function_name, $mode));
    return;
}
sub auth_modify {
    my ($self, $message, $command, $rpl, $function_name, $nick_name) = @_;
    my $mode = $command eq 'auth-allow' ? 'allow' : 'deny';
    unless (defined $function_name && defined $nick_name) {
        $message->response->raise('Must provide both a function name and a nick to %s permissions.', $mode);
        return;
    }
    unless (exists $self->bot->commands->{lc($function_name)}) {
        $message->response->raise('The function "%s" is not known.', $function_name);
        return;
    }
    my $nick = App::RoboBot::Nick->new( config => $self->bot->config, name => "$nick_name" );
    unless ($nick->has_id) {
        $message->response->raise('The nick %s is unfamiliar to me. I cannot modify permissions for them yet.', $nick_name);
        return;
    }
    my $res = $self->bot->config->db->do(q{
        update auth_permissions
        set ???
        where network_id = ? and nick_id = ? and lower(command) = lower(?)
    }, { state => $mode, granted_by => $message->sender->id }, $message->network->id, $nick->id, $function_name);
    unless ($res && $res->count > 0) {
        $res = $self->bot->config->db->do(q{
            insert into auth_permissions ???
        }, {
            network_id  => $message->network->id,
            nick_id    => $nick->id,
            command    => lc($function_name),
            state      => $mode,
            granted_by => $message->sender->id,
        });
    }
    $message->response->push(sprintf('The nick %s is now %s permission to run the function %s.', $nick->name, ($mode eq 'allow' ? 'allowed' : 'denied'), $function_name));
    return;
}
__PACKAGE__->meta->make_immutable;
1;