Authorization/Driver/Generic.pm

filter: Statementstmt 100% 18 / 18 Branchbran 100% 4 / 4 Conditioncond 100% 3 / 3 MC/DCmcdc 100% 2 / 2 Subroutinesub 100% 4 / 4 Podpod 100% 1 / 1 totaltotal 100% 32 / 32 CC 5 SCAR 12.5
CC
5
Cov
100%
authorize_user
5.0
BEGIN
1.0
BEGIN
1.0
CRAP 3.5
« Authorization/Driver/SimpleGroup.pm ↑ Summary Authorization/Driver/HTGroup.pm »
1 package CGI::Application::Plugin::Authorization::Driver::Generic;
2  
3 5 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 5 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 5 ▶use base qw(CGI::Application::Plugin::Authorization::Driver);
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8  
9 =head1 NAME
10  
11 CGI::Application::Plugin::Authorization::Driver::Generic - Generic Authorization driver
12  
13  
14 =head1 SYNOPSIS
15  
16 use base qw(CGI::Application);
17 use CGI::Application::Plugin::Authorization;
18  
19 my %groupmap = (
20 testuser => 'testgroup',
21 );
22  
23 # See docs for authorize_user below for an explanation
24 __PACKAGE__->authz->config(
25 DRIVER => [ 'Generic', sub {
26 my ($username,$group) = @_;
27 return ($groupmap{$username} eq $group);
28 } ],
29 );
30  
31  
32 =head1 METHODS
33  
34 =head2 authorize_user
35  
36 This method accepts a username followed by a list of group names and will
37 return true if the user belongs to at least one of the groups.
38  
39 It does this by calling the provided callback with the username and a
40 single group until a match is found.
41  
42 =cut
43  
44 25 ▶sub authorize_user {
Subroutine authorize_user: called CC=5 SCAR=16.1
Pod documented
45 25 my $self = shift;
46 25 my $username = shift;
47 25 my @groups = @_;
48  
49 # verify that all the options are OK
50 25 my ($check) = $self->options;
51 25 ▶ die "The Generic driver requires a subroutine reference as its only option" unless $check && ref $check eq 'CODE';
Branch: 1 branch
BranchTrueFalseTotal
unless $check and ref $check eq "CODE" 2 23 25
Condition100%3/3
$check and ref $check eq "CODE"
!ll&&!rl&&r
1123
MC/DC100%2/2
$check and ref $check eq "CODE"
$check ref $check eq "CODE"
Truth table100%3/3
A and B
A= $checkB= ref $check eq "CODE"
ABresult
0X0
100
111
52  
53 23 foreach my $group (@groups) {
54 25 ▶ return 1 if $check->($username, $group);
Branch: 1 branch
BranchTrueFalseTotal
if &$check($username, $group) 8 17 25
55 }
56 15 return 0;
57 }
58  
59  
60 =head1 SEE ALSO
61  
62 L<CGI::Application::Plugin::Authorization::Driver>, L<CGI::Application::Plugin::Authorization>, perl(1)
63  
64  
65 =head1 LICENCE AND COPYRIGHT
66  
67 Copyright (c) 2005, SiteSuite. All rights reserved.
68  
69 This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
70  
71  
72 =head1 DISCLAIMER OF WARRANTY
73  
74 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
75  
76 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
77  
78 =cut
79  
80 5 1;
« Authorization/Driver/SimpleGroup.pm ↑ Summary Authorization/Driver/HTGroup.pm »