The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

BARBIE / Labyrinth-5.32 / lib / Labyrinth / Users.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
177
178
179
180
181
182
183
184
185
186
187
188
—
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207

              
package Labyrinth::Users;
use warnings;
use strict;
use vars qw($VERSION @ISA %EXPORT_TAGS @EXPORT @EXPORT_OK);
$VERSION = '5.32';
=head1 NAME
Labyrinth::Users - Generic User Management for Labyrinth
=head1 DESCRIPTION
Contains generic user functionality that are required across the Labyrinth
framework, and may be used within plugins.
=cut
# -------------------------------------
# Export Details
require Exporter;
@ISA = qw(Exporter);
%EXPORT_TAGS = (
    'all' => [ qw( GetUser UserName UserID FreshPassword PasswordCheck UserSelect ) ]
);
@EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
@EXPORT    = ( @{ $EXPORT_TAGS{'all'} } );
# -------------------------------------
# Library Modules
use Labyrinth::Audit;
use Labyrinth::Globals;
use Labyrinth::DBUtils;
use Labyrinth::MLUtils;
use Labyrinth::Variables;
use Session::Token;
# -------------------------------------
# Variables
my (%users,%userids);  # quick lookup hashes
# -------------------------------------
# The Subs
=head1 PUBLIC INTERFACE METHODS
=over 4
=item GetUser($id)
Given a user id, performs a database lookup, unless a previous lookup for the
same id has already been requested.
=item UserName($id)
Given a user id, returns the user's name.
=item UserID
Given a user's name (real name or nick name), returns the user id.
=item FreshPassword
Returns a generated password string.
=item PasswordCheck
Checks the given password against the required rules.
=back
=cut
sub GetUser {
    my $uid = shift;
    return  unless($uid);
    $users{$uid} ||= do {
        my @rows = $dbi->GetQuery('hash','GetUserByID',$uid);
        $rows[0]    if(@rows);
    };
    return $users{$uid};
}
sub UserName {
    my $uid = shift;
    return  unless($uid);
    my $user = GetUser($uid);
    return $user->{realname} || $user->{nickname};
}
sub UserID {
    my $name = shift;
    return  unless($name);
    $userids{$name} ||= do {
        my @rows = $dbi->GetQuery('hash','GetUserByName',$name);
        return  unless(@rows);
        $users{$rows[0]->{userid}} ||= $rows[0];
        $rows[0]->{userid};
    };
    return $userids{$name};
}
sub FreshPassword {
    my $gen = Session::Token->new(length => 10);
    return $gen->get();
}
sub PasswordCheck {
    my $password = shift || return 6;
    my $plen = length $password;
    return 4    if($password =~ /\s/);
    return 1    if($settings{minpasslen} && $plen < $settings{minpasslen});
    return 2    if($settings{maxpasslen} && $plen > $settings{maxpasslen});
    # Check unique characters
    my @chars = split //,$password ;
    my %unique ;
    foreach my $char (@chars) {
        $unique{$char}++;
    }
    return 5    if(scalar keys %unique < 3);
    my $types = 0;
    $types++    if($password =~ /[a-z]/);
    $types++    if($password =~ /[A-Z]/);
    $types++    if($password =~ /\d/);
    $types++    if($password =~ /[^a-zA-Z\d]/);
    return 0    if($types > 1);
    return 3;
}
=head1 ADMIN INTERFACE METHODS
=over 4
=item UserSelect
Provides a dropdown selection box, as a XHTML code snippet, of the currently 
listed users.
By default only users listed as searchable are listed.
=back
=cut
sub UserSelect {
    my $opt   = shift;
    my $multi = shift || 5;
    my $blank = shift || 0;
    my $field = shift || 'userid';
    my $title = shift || 'Name';
    my $all   = shift;
    my $search;
    $search = 'WHERE search=1'   unless($all);
    my @rows = $dbi->GetQuery('hash','AllUsers',{search=>$search});
    foreach (@rows) { 
        my @names;
        push @names, $_->{realname}             if($_->{realname});
        push @names, '(' . $_->{nickname} . ')' if($_->{nickname});
        $_->{name}   = join(' ',@names)   if(@names);
        $_->{name} ||= 'No Name Given';
    }
    unshift @rows, {userid=>0,name=>"Select $title"}    if($blank == 1);
    return DropDownMultiRows($opt,$field,'userid','name',$multi,@rows) if($multi > 1);
    return DropDownRows($opt,$field,'userid','name',@rows);
}
1;
__END__
=head1 SEE ALSO
  Labyrinth
=head1 AUTHOR
Barbie, <barbie@missbarbell.co.uk> for
Miss Barbell Productions, L<http://www.missbarbell.co.uk/>
=head1 COPYRIGHT & LICENSE
  Copyright (C) 2002-2015 Barbie for Miss Barbell Productions
  All Rights Reserved.
  This module is free software; you can redistribute it and/or
  modify it under the Artistic License 2.0.
=cut