blib/lib/Data/LazyACL.pm

filter: Statementstmt 100% 81 / 81 Branchbran 89.2% 25 / 28 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 12 / 12 Podpod 100% 8 / 8 totaltotal 97.6% 126 / 129 CC 19 SCAR 13.7
CC
19
Cov
97%
has_privilege
6.0
retrieve_access_keys_in_hash_for
5.0
retrieve_access_keys_for
5.0
CRAP 3.9
↑ Summary
1 package Data::LazyACL;
2  
3 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 3 ▶use Math::BigInt;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 3 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 3 ▶use vars qw/$VERSION/;
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 3 $VERSION = '0.05';
9  
10 3 my $ADMIN_NUMBER = -1;
11  
12 2 ▶sub new {
Subroutine new: called CC=1 SCAR=0.0
Pod documented
13 2 my $class = shift;
14 2 my $s = {};
15  
16 2 bless $s , $class;
17 }
18  
19 1 ▶sub get_all_access_keys {
Subroutine get_all_access_keys: called CC=1 SCAR=0.0
Pod documented
20 1 my $s = shift;
21 1 return $s->{all_access_keys};
22 }
23  
24 3 ▶sub set_all_access_keys {
Subroutine set_all_access_keys: called CC=3 SCAR=11.0
Pod documented
25 3 my $s = shift;
26 3 my $access_keys = shift;
27  
28 3 $s->{all_access_keys} = $access_keys ;
29  
30 3 my $digit = 1;
31 3 for my $access_key ( @{ $access_keys } ) {
32
33 10005 ▶ if( $access_key eq 'admin' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($access_key eq "admin") 1 10004 10005
34 1 croak q{You can not use reserved word 'admin' as access key.};
35 }
36
37 10004 $s->{access_key}{ $access_key } = $digit;
38 10004 $digit++;
39 }
40 2 $s->{access_key}{admin} = $ADMIN_NUMBER;
41 }
42  
43 9 ▶sub has_privilege {
Subroutine has_privilege: called CC=6 SCAR=17.9
Pod documented
44 9 my $s = shift;
45 9 my $access_key = shift;
46  
47 9 ▶ return 0 unless defined $s->{token};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $s->{"token"} 0 9 9
48 # admin
49 9 ▶ return 1 if $s->{token} eq $ADMIN_NUMBER ;
Branch: 1 branch
BranchTrueFalseTotal
if $s->{"token"} eq $ADMIN_NUMBER 1 8 9
50  
51 # required admin
52 8 ▶ return 0 if $access_key eq 'admin';
Branch: 1 branch
BranchTrueFalseTotal
if $access_key eq "admin" 1 7 8
53  
54 7 my $access_digit = $s->{access_key}{ $access_key } ;
55
56 7 ▶ croak 'can not find access key [' . $access_key . ']' unless $access_digit;
Branch: 1 branch
BranchTrueFalseTotal
unless $access_digit 1 6 7
57 6 my $acl = Math::BigInt->new( 2 );
58 6 $acl->bpow( $access_digit - 1 );
59 6 ▶ return $acl->band( $s->{token} ) ? 1 : 0;
Branch: 1 branch
BranchTrueFalseTotal
$acl->band($s->{'token'}) ? : 4 2 6
60 }
61  
62 3 ▶sub set_token {
Subroutine set_token: called CC=1 SCAR=0.0
Pod documented
63 3 my $s = shift;
64 3 my $token = shift;
65 3 $s->{token} = $token ;
66 }
67  
68 3 ▶sub generate_token {
Subroutine generate_token: called CC=4 SCAR=13.9
Pod documented
69 3 my $s = shift;
70 3 my $access_keys = shift;
71
72 3 my $acl = Math::BigInt->new();
73  
74 3 for my $access_key ( @{ $access_keys } ) {
75 6 ▶ return $ADMIN_NUMBER if $access_key eq 'admin';
Branch: 1 branch
BranchTrueFalseTotal
if $access_key eq "admin" 1 5 6
76  
77 5 my $digit = $s->{access_key}{ $access_key } ;
78
79 5 ▶ croak 'can not find access key [' . $access_key . ']' unless $digit;
Branch: 1 branch
BranchTrueFalseTotal
unless $digit 0 5 5
80  
81 5 my $i = Math::BigInt->new( 2 );
82  
83 5 $acl->badd( $i->bpow( $digit -1 ) );
84 }
85 2 return $acl->numify();
86  
87 }
88  
89 2 ▶sub retrieve_access_keys_for {
Subroutine retrieve_access_keys_for: called CC=5 SCAR=16.1
Pod documented
90 2 my $s = shift;
91 2 my $token = shift;
92 2 my @access_keys = ();
93  
94 2 ▶ return ['admin'] if $token eq $ADMIN_NUMBER;
Branch: 1 branch
BranchTrueFalseTotal
if $token eq $ADMIN_NUMBER 1 1 2
95  
96 1 foreach my $key ( keys %{ $s->{access_key} } ) {
97 4 ▶ next if $key eq 'admin';
Branch: 1 branch
BranchTrueFalseTotal
if $key eq "admin" 1 3 4
98 3 my $mb = Math::BigInt->new('2');
99 3 my $digit = $s->{access_key}{ $key };
100  
101 3 $mb->bpow( $digit - 1 );
102
103 3 ▶ if( $mb->band( $token ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($mb->band($token)) 2 1 3
104 2 push @access_keys , $key ;
105 }
106  
107 }
108  
109 1 return \@access_keys;
110 }
111  
112 1 ▶sub retrieve_access_keys_in_hash_for {
Subroutine retrieve_access_keys_in_hash_for: called CC=5 SCAR=16.1
Pod documented
113 1 my $s = shift;
114 1 my $token = shift;
115 1 my $access_keys = {};
116  
117 1 ▶ return {admin => 1} if $token eq $ADMIN_NUMBER;
Branch: 1 branch
BranchTrueFalseTotal
if $token eq $ADMIN_NUMBER 0 1 1
118  
119 1 foreach my $key ( keys %{ $s->{access_key} } ) {
120 4 ▶ next if $key eq 'admin';
Branch: 1 branch
BranchTrueFalseTotal
if $key eq "admin" 1 3 4
121 3 my $mb = Math::BigInt->new('2');
122 3 my $digit = $s->{access_key}{ $key };
123  
124 3 $mb->bpow( $digit - 1 );
125
126 3 ▶ if( $mb->band( $token ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($mb->band($token)) 2 1 3
127 2 $access_keys->{ $key } = 1;
128 }
129  
130 }
131 1 return $access_keys;
132 }
133 3 1;
134  
135 =head1 NAME
136  
137 Data::LazyACL - Simple and Easy Access Control List
138  
139 =head1 DESCRIPTION
140  
141 I am tired of having multiple flags or columns or whatever to implement Access
142 Control List , so I create this module.
143  
144 This module is simple and easy to use, a user only need to have a token
145 to check having access or not.
146  
147 =head1 SYNOPSYS
148  
149 my $acl = Data::LazyACL->new();
150 $acl->set_all_access_keys( [qw/edit insert view/]);
151  
152 my ( $edit , insert , view ) = $s->get_all_access_keys();
153  
154 # maybe you want to store this token into user record.
155 my $token = $acl->generate_token([qw/view insert/]);
156  
157 $acl->set_token( $token );
158  
159 if ( $acl->has_privilege( 'view' ) ) {
160 print "You can view me!!\n";
161 }
162  
163 if ( $acl->has_privilege( 'edit' ) ) {
164 print "Never Dispaly\n";
165 }
166
167 my $access_keys_ref
168 = $acl->retrieve_access_keys_for( $token );
169
170 my $access_keys_hash_ref
171 = $acl->retrieve_access_keys_in_hash_for( $token );
172  
173 =head1 METHODS
174  
175 =head2 new()
176  
177 Constractor.
178  
179 =head2 set_all_access_keys( \@access_keys )
180  
181 Set all access keys. You can never change this array of order once you
182 generate token , otherwise you will messup permissins. When you want to add new keys then just append.
183  
184 =head2 $token = generate_token( \@user_access_keys )
185  
186 Generate token. You may want to save this token for per user.
187  
188 =head2 \@access_keys = get_all_access_keys()
189  
190 Get access keys which you set with set_all_access_keys() .. means not include
191 'admin'.
192  
193 =head2 set_token( $token )
194  
195 You need to set $token to use has_privilege() method. the has_privilege()
196 method check privilege based on this token.
197  
198 If you want to have all access then use reserve keyword 'admin' .
199  
200 my $admin_token = $acl->set_token( 'admin' );
201  
202 =head2 has_privilege( $access_key )
203  
204 check having privilege or not for the access_key.
205  
206 =head2 $keys_ref = retrieve_access_keys_for( $token )
207  
208 Get access keys array ref for a token.
209  
210 =head2 $keys_hash_ref = retrieve_access_keys_in_hash_for( $token )
211  
212 Get access keys as hash key. value is 1.
213  
214 =head1 Token can be big number
215  
216 Token can be big number when you add a lot of access keys, so I suggest
217 you treat Token as String not Integer when you want to store it into database.
218  
219 =head1 AUTHOR
220  
221 Tomohiro Teranishi <tomohiro.teranishi+cpan@gmail.com>
222  
223 =head1 COPYRIGHT
224  
225 This program is free software. you can redistribute it and/or modify it under
226 the same terms as Perl itself.
227  
228 =cut
↑ Summary