Sling/LDAPSynch.pm

filter: Statementstmt 32.3% 119 / 368 Branchbran 18.3% 25 / 136 Conditioncond 22.2% 2 / 9 MC/DCmcdc 16.6% 1 / 6 Subroutinesub 56.7% 21 / 37 Podpod 82.6% 19 / 23 totaltotal 32.3% 187 / 579 CC 77 SCAR 38.6
CC
77
Cov
28%
perform_synchronization
210.0
synch_full
56.0
run
49.7
CRAP 47.5
« Sling/Authz.pm ↑ Summary Sling/User.pm »
1 #!/usr/bin/perl -w
2  
3 package Apache::Sling::LDAPSynch;
4  
5 1 ▶use 5.008001;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 1 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 1 ▶use Getopt::Long qw(:config bundling);
Subroutine BEGIN: called CC=1 SCAR=0.0
10 1 ▶use Apache::Sling;
Subroutine BEGIN: called CC=1 SCAR=0.0
11 1 ▶use Apache::Sling::Authn;
Subroutine BEGIN: called CC=1 SCAR=0.0
12 1 ▶use Apache::Sling::Content;
Subroutine BEGIN: called CC=1 SCAR=0.0
13 1 ▶use Apache::Sling::User;
Subroutine BEGIN: called CC=1 SCAR=0.0
14 1 ▶use Data::Dumper;
Subroutine BEGIN: called CC=1 SCAR=0.0
15 1 ▶use Fcntl ':flock';
Subroutine BEGIN: called CC=1 SCAR=0.0
16 1 ▶use File::Temp;
Subroutine BEGIN: called CC=1 SCAR=0.0
17 1 ▶use Net::LDAP;
Subroutine BEGIN: called CC=1 SCAR=0.0
18  
19 1 require Exporter;
20  
21 1 ▶use base qw(Exporter);
Subroutine BEGIN: called CC=1 SCAR=0.0
22  
23 1 our @EXPORT_OK = qw(command_line);
24  
25 1 our $VERSION = '0.27';
26  
27 #{{{sub new
28  
29 2 ▶sub new {
Subroutine new: called CC=7 SCAR=19.8
Pod documented
30 my (
31 2 $class, $ldap_host, $ldap_base, $filter, $dn,
32 $pass, $authn, $disabled, $verbose, $log
33 ) = @_;
34 2 ▶ if ( !defined $authn ) { croak 'no authn provided!'; }
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $authn) 1 1 2
35 1 ▶ $disabled = ( defined $disabled ? $disabled : q(sling:disabled) );
Branch: 1 branch
BranchTrueFalseTotal
defined $disabled ? : 0 1 1
36 1 ▶ $filter = ( defined $filter ? $filter : q(uid) );
Branch: 1 branch
BranchTrueFalseTotal
defined $filter ? : 1 0 1
37 1 ▶ $verbose = ( defined $verbose ? $verbose : 0 );
Branch: 1 branch
BranchTrueFalseTotal
defined $verbose ? : 0 1 1
38  
39 # Directory containing the cache and user_list files:
40 1 my $synch_cache_path =
41 q(_user/a/ad/admin/private/ldap_synch_cache_system_files);
42  
43 # Directory containing backups of the cache and user_list files:
44 1 my $synch_cache_backup_path =
45 q(_user/a/ad/admin/private/ldap_synch_cache_system_files_backup);
46  
47 # List of specific users previously ingested in to the sling system and their status:
48 1 my $synch_cache_file = q(cache.txt);
49  
50 # List of specific ldap users that are to be ingested in to the sling system:
51 1 my $synch_user_list = q(user_list.txt);
52 1 my $ldap;
53 1 ▶ my $content = Apache::Sling::Content->new( $authn, $verbose, $log )
Branch: 1 branch
BranchTrueFalseTotal
my $content = "Apache::Sling::Content"->new($authn, $verbose, $log) or croak("Problem creating Sling content object!") 1 0 1
54 or croak q(Problem creating Sling content object!);
55 1 ▶ my $user = Apache::Sling::User->new( $authn, $verbose, $log )
Branch: 1 branch
BranchTrueFalseTotal
my $user = "Apache::Sling::User"->new($authn, $verbose, $log) or croak("Problem creating Sling user object!") 1 0 1
56 or croak q(Problem creating Sling user object!);
57 1 my $ldap_synch = {
58 CacheBackupPath => $synch_cache_backup_path,
59 CachePath => $synch_cache_path,
60 CacheFile => $synch_cache_file,
61 Content => \$content,
62 Disabled => $disabled,
63 LDAP => \$ldap,
64 LDAPbase => $ldap_base,
65 LDAPDN => $dn,
66 LDAPHost => $ldap_host,
67 LDAPPass => $pass,
68 Filter => $filter,
69 Log => $log,
70 Message => q(),
71 User => \$user,
72 UserList => $synch_user_list,
73 Verbose => $verbose
74 };
75 1 bless $ldap_synch, $class;
76 1 return $ldap_synch;
77 }
78  
79 #}}}
80  
81 #{{{sub ldap_connect
82  
83 0 ▶sub ldap_connect {
Subroutine ldap_connect: not called CC=6 SCAR=37.4
Pod documented
84 0 my ($class) = @_;
85 0 ▶ $class->{'LDAP'} = Net::LDAP->new( $class->{'LDAPHost'} )
Branch: 1 branch
BranchTrueFalseTotal
$class->{"LDAP"} = "Net::LDAP"->new($class->{"LDAPHost"}) or croak("Problem opening a connection to the LDAP server!") 0 0 0
86 or croak 'Problem opening a connection to the LDAP server!';
87 0 ▶ if ( defined $class->{'LDAPDN'} && defined $class->{'LDAPPASS'} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $class->{'LDAPDN'} and defined $class->{'LDAPPASS'}) { } 0 0 0
Condition0%0/3
defined $class->{"LDAPDN"} and defined $class->{"LDAPPASS"}
!ll&&!rl&&r
000
MC/DC0%0/2
defined $class->{"LDAPDN"} and defined $class->{"LDAPPASS"}
defined $class->{"LDAPDN"} defined $class->{"LDAPPASS"}
Truth table0%0/3
A and B
A= defined $class->{"LDAPDN"}B= defined $class->{"LDAPPASS"}
ABresult
0X0
100
111
88 my $mesg = $class->{'LDAP'}->bind(
89 $class->{'LDAPDN'},
90 0 ▶ password => $class->{'LDAPPASS'},
Branch: 1 branch
BranchTrueFalseTotal
my $mesg = $class->{"LDAP"}->bind($class->{"LDAPDN"}, "password", $class->{"LDAPPASS"}, "version", 3) or croak("Problem with authenticated bind to LDAP server!") 0 0 0
91 version => '3'
92 ) or croak 'Problem with authenticated bind to LDAP server!';
93 }
94 else {
95 0 ▶ my $mesg = $class->{'LDAP'}->bind( version => '3' )
Branch: 1 branch
BranchTrueFalseTotal
my $mesg = $class->{"LDAP"}->bind("version", 3) or croak("Problem with anonymous bind to LDAP server!") 0 0 0
96 or croak 'Problem with anonymous bind to LDAP server!';
97 }
98 0 return 1;
99 }
100  
101 #}}}
102  
103 #{{{sub ldap_search
104  
105 0 ▶sub ldap_search {
Subroutine ldap_search: not called CC=1 SCAR=6.9
Pod documented
106 0 my ( $class, $search, $attrs ) = @_;
107 0 $class->ldap_connect;
108 return $class->{'LDAP'}->search(
109 0 base => $class->{'LDAPbase'},
110 scope => 'sub',
111 filter => "$search",
112 attrs => $attrs
113 )->as_struct;
114 }
115  
116 #}}}
117  
118 #{{{sub init_synch_cache
119  
120 0 ▶sub init_synch_cache {
Subroutine init_synch_cache: not called CC=6 SCAR=37.4
Pod documented
121 0 my ($class) = @_;
122 0 ▶ if ( !${ $class->{'Content'} }
Branch: 1 branch
BranchTrueFalseTotal
unless (${$$class{"Content"};}->check_exists($class->{"CachePath"} . '/' . $class->{"CacheFile"})) 0 0 0
123 ->check_exists( $class->{'CachePath'} . q(/) . $class->{'CacheFile'} ) )
124 {
125 0 my ( $tmp_cache_file_handle, $tmp_cache_file_name ) =
126 File::Temp::tempfile();
127 0 my %synch_cache;
128 0 ▶ print {$tmp_cache_file_handle}
Branch: 1 branch
BranchTrueFalseTotal
print {$tmp_cache_file_handle;} "Data::Dumper"->Dump([\%synch_cache], ["synch_cache"]) or croak("Unable to print initial data dump of synch cache to file!") 0 0 0
129 Data::Dumper->Dump( [ \%synch_cache ], [qw( synch_cache )] )
130 or croak q(Unable to print initial data dump of synch cache to file!);
131 0 ▶ close $tmp_cache_file_handle
Branch: 1 branch
BranchTrueFalseTotal
close $tmp_cache_file_handle or croak("Problem closing temporary file handle when initializing synch cache") 0 0 0
132 or croak
133 q(Problem closing temporary file handle when initializing synch cache);
134 0 ${ $class->{'Content'} }
135 ->upload_file( $tmp_cache_file_name, $class->{'CachePath'},
136 0 ▶ $class->{'CacheFile'} )
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"Content"};}->upload_file($tmp_cache_file_name, $class->{"CachePath"}, $class->{"CacheFile"}) or croak("Unable to initialize LDAP synch cache file!") 0 0 0
137 or croak q(Unable to initialize LDAP synch cache file!);
138 0 ▶ unlink $tmp_cache_file_name
Branch: 1 branch
BranchTrueFalseTotal
unlink $tmp_cache_file_name or croak("Problem clearing up temporary file after init of synch cache!") 0 0 0
139 or croak
140 q(Problem clearing up temporary file after init of synch cache!);
141 }
142 0 return 1;
143 }
144  
145 #}}}
146  
147 #{{{sub get_synch_cache
148  
149 0 ▶sub get_synch_cache {
Subroutine get_synch_cache: not called CC=4 SCAR=30.0
Pod documented
150 0 my ($class) = @_;
151 0 $class->init_synch_cache();
152 0 ▶ if ( !${ $class->{'Content'} }
Branch: 1 branch
BranchTrueFalseTotal
unless (${$$class{"Content"};}->check_exists($class->{"CachePath"} . '/' . $class->{"CacheFile"})) 0 0 0
153 ->check_exists( $class->{'CachePath'} . q(/) . $class->{'CacheFile'} ) )
154 {
155 0 croak q(No synch cache file present - initialization must have failed!);
156 }
157 0 ${ $class->{'Content'} }
158 0 ▶ ->view_file( $class->{'CachePath'} . q(/) . $class->{'CacheFile'} )
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"Content"};}->view_file($class->{"CachePath"} . '/' . $class->{"CacheFile"}) or croak("Problem viewing synch cache file") 0 0 0
159 or croak q(Problem viewing synch cache file);
160 0 my $synch_cache;
161 0 my $success = eval ${ $class->{'Content'} }->{'Message'};
162 0 ▶ if ( !defined $success ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $success) 0 0 0
163 0 croak q{Error parsing synchronized cache dump.};
164 }
165 0 return $synch_cache;
166 }
167  
168 #}}}
169  
170 #{{{sub update_synch_cache
171  
172 0 ▶sub update_synch_cache {
Subroutine update_synch_cache: not called CC=6 SCAR=37.4
Pod documented
173 0 my ( $class, $synch_cache ) = @_;
174 0 my ( $tmp_cache_file_handle, $tmp_cache_file_name ) =
175 File::Temp::tempfile();
176 0 ▶ print {$tmp_cache_file_handle}
Branch: 1 branch
BranchTrueFalseTotal
print {$tmp_cache_file_handle;} "Data::Dumper"->Dump([$synch_cache], ["synch_cache"]) or croak("Unable to print data dump of synch cache to file!") 0 0 0
177 Data::Dumper->Dump( [$synch_cache], [qw( synch_cache )] )
178 or croak q(Unable to print data dump of synch cache to file!);
179 0 ▶ close $tmp_cache_file_handle
Branch: 1 branch
BranchTrueFalseTotal
close $tmp_cache_file_handle or croak("Problem closing temporary file handle when updating synch cache") 0 0 0
180 or croak
181 q(Problem closing temporary file handle when updating synch cache);
182 0 ${ $class->{'Content'} }
183 ->upload_file( $tmp_cache_file_name, $class->{'CachePath'},
184 0 ▶ $class->{'CacheFile'} )
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"Content"};}->upload_file($tmp_cache_file_name, $class->{"CachePath"}, $class->{"CacheFile"}) or croak("Unable to update LDAP synch cache file!") 0 0 0
185 or croak q(Unable to update LDAP synch cache file!);
186 0 my $time = time;
187 0 ${ $class->{'Content'} }
188 0 ▶ ->upload_file( $tmp_cache_file_name, $class->{'CacheBackupPath'},
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"Content"};}->upload_file($tmp_cache_file_name, $class->{"CacheBackupPath"}, "cache$time.txt") or croak("Unable to create LDAP synch cache backup file!") 0 0 0
189 "cache$time.txt" )
190 or croak q(Unable to create LDAP synch cache backup file!);
191 0 ▶ unlink $tmp_cache_file_name
Branch: 1 branch
BranchTrueFalseTotal
unlink $tmp_cache_file_name or croak("Problem clearing up temporary file after updating synch cache!") 0 0 0
192 or croak
193 q(Problem clearing up temporary file after updating synch cache!);
194 0 return 1;
195 }
196  
197 #}}}
198  
199 #{{{sub get_synch_user_list
200  
201 0 ▶sub get_synch_user_list {
Subroutine get_synch_user_list: not called CC=4 SCAR=30.0
Pod documented
202 0 my ($class) = @_;
203 0 ▶ if ( !${ $class->{'Content'} }
Branch: 1 branch
BranchTrueFalseTotal
unless (${$$class{"Content"};}->check_exists($class->{"CachePath"} . '/' . $class->{"UserList"})) 0 0 0
204 ->check_exists( $class->{'CachePath'} . q(/) . $class->{'UserList'} ) )
205 {
206 0 croak q(No user list file present - you need to create one!);
207 }
208 0 ${ $class->{'Content'} }
209 0 ▶ ->view_file( $class->{'CachePath'} . q(/) . $class->{'UserList'} )
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"Content"};}->view_file($class->{"CachePath"} . '/' . $class->{"UserList"}) or croak("Problem viewing synch user list") 0 0 0
210 or croak q(Problem viewing synch user list);
211 0 my $synch_user_list;
212 0 my $success = eval ${ $class->{'Content'} }->{'Message'};
213 0 ▶ if ( !defined $success ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $success) 0 0 0
214 0 croak q{Error parsing synchronized user list dump.};
215 }
216 0 return $synch_user_list;
217 }
218  
219 #}}}
220  
221 #{{{sub update_synch_user_list
222  
223 0 ▶sub update_synch_user_list {
Subroutine update_synch_user_list: not called CC=6 SCAR=37.4
Pod documented
224 0 my ( $class, $synch_user_list ) = @_;
225 0 my ( $tmp_user_list_file_handle, $tmp_user_list_file_name ) =
226 File::Temp::tempfile();
227 0 ▶ print {$tmp_user_list_file_handle}
Branch: 1 branch
BranchTrueFalseTotal
print {$tmp_user_list_file_handle;} "Data::Dumper"->Dump([$synch_user_list], ["synch_user_list"]) or croak("Unable to print data dump of synch user list to file!") 0 0 0
228 Data::Dumper->Dump( [$synch_user_list], [qw( synch_user_list )] )
229 or croak q(Unable to print data dump of synch user list to file!);
230 0 ▶ close $tmp_user_list_file_handle
Branch: 1 branch
BranchTrueFalseTotal
close $tmp_user_list_file_handle or croak("Problem closing temporary file handle when writing synch user list") 0 0 0
231 or croak
232 q(Problem closing temporary file handle when writing synch user list);
233 0 ${ $class->{'Content'} }
234 ->upload_file( $tmp_user_list_file_name, $class->{'CachePath'},
235 0 ▶ $class->{'UserList'} )
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"Content"};}->upload_file($tmp_user_list_file_name, $class->{"CachePath"}, $class->{"UserList"}) or croak("Unable to upload LDAP synch user list file into sling instance!") 0 0 0
236 or croak
237 q(Unable to upload LDAP synch user list file into sling instance!);
238 0 Apache::Sling::Print::print_result( ${ $class->{'Content'} } );
239 0 my $time = time;
240 0 ${ $class->{'Content'} }
241 0 ▶ ->upload_file( $tmp_user_list_file_name, $class->{'CacheBackupPath'},
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"Content"};}->upload_file($tmp_user_list_file_name, $class->{"CacheBackupPath"}, "user_list$time.txt") or croak("Unable to create LDAP synch user list backup file!") 0 0 0
242 "user_list$time.txt" )
243 or croak q(Unable to create LDAP synch user list backup file!);
244 0 ▶ unlink $tmp_user_list_file_name
Branch: 1 branch
BranchTrueFalseTotal
unlink $tmp_user_list_file_name or croak("Problem clearing up temporary file after updating synch user list!") 0 0 0
245 or croak
246 q(Problem clearing up temporary file after updating synch user list!);
247 0 return 1;
248 }
249  
250 #}}}
251  
252 #{{{sub download_synch_user_list
253  
254 0 ▶sub download_synch_user_list {
Subroutine download_synch_user_list: not called CC=5 SCAR=34.0
Pod documented
255 0 my ( $class, $user_list_file ) = @_;
256 0 my $synch_user_list = $class->get_synch_user_list;
257 0 foreach my $user ( sort keys %{$synch_user_list} ) {
258 0 ▶ if ( open my $out, '>>', $user_list_file ) {
Branch: 1 branch
BranchTrueFalseTotal
if (open my $out, '>>', $user_list_file) { } 0 0 0
259 0 flock $out, LOCK_EX;
260 0 ▶ print {$out} $user . "\n"
Branch: 1 branch
BranchTrueFalseTotal
print {$out;} $user . "\n" or croak("Problem printing when downloading synchronized user list!") 0 0 0
261 or croak
262 q(Problem printing when downloading synchronized user list!);
263 0 flock $out, LOCK_UN;
264 0 ▶ close $out
Branch: 1 branch
BranchTrueFalseTotal
close $out or croak("Problem closing file handle when downloading synchronized user list!") 0 0 0
265 or croak
266 q(Problem closing file handle when downloading synchronized user list!);
267 }
268 else {
269 0 croak q(Could not open file to download synchronized user list to!);
270 }
271 }
272 0 $class->{'Message'} =
273 "Successfully downloaded user list to $user_list_file!";
274 0 return 1;
275 }
276  
277 #}}}
278  
279 #{{{sub upload_synch_user_list
280  
281 0 ▶sub upload_synch_user_list {
Subroutine upload_synch_user_list: not called CC=4 SCAR=30.0
Pod documented
282 0 my ( $class, $user_list_file ) = @_;
283 0 my %user_list_hash;
284 0 ▶ if ( open my ($input), '<', $user_list_file ) {
Branch: 1 branch
BranchTrueFalseTotal
if (open my $input, '<', $user_list_file) { } 0 0 0
285 0 ▶ while (<$input>) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($_ = readline $input)) 0 0 0
286 0 chomp;
287 0 $user_list_hash{$_} = 1;
288 }
289 0 ▶ close $input or croak q(Problem closing upload user list file handle!);
Branch: 1 branch
BranchTrueFalseTotal
close $input or croak("Problem closing upload user list file handle!") 0 0 0
290 }
291 else {
292 0 croak q(Unable to open synch user list file to parse for upload!);
293 }
294 0 $class->update_synch_user_list( \%user_list_hash );
295 0 $class->{'Message'} =
296 q(Successfully uploaded user list for use in subsequent synchronizations!);
297 0 return 1;
298 }
299  
300 #}}}
301  
302 #{{{sub parse_attributes
303  
304 3 ▶sub parse_attributes {
Subroutine parse_attributes: called CC=6 SCAR=18.0
Pod documented
305 3 my ( $ldap_attrs, $sling_attrs, $ldap_attrs_array, $sling_attrs_array ) =
306 @_;
307 3 ▶ if ( defined $ldap_attrs_array && defined $sling_attrs_array ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $ldap_attrs_array and defined $sling_attrs_array) 2 1 3
Condition66%2/3
defined $ldap_attrs_array and defined $sling_attrs_array
!ll&&!rl&&r
102
MC/DC50%1/2
defined $ldap_attrs_array and defined $sling_attrs_array
defined $ldap_attrs_array defined $sling_attrs_array
Truth table66%2/3
A and B
A= defined $ldap_attrs_arrayB= defined $sling_attrs_array
ABresult
0X0
100
111
308 2 ▶ if ( defined $ldap_attrs ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $ldap_attrs) 2 0 2
309 2 @{$ldap_attrs_array} = split /,/msx, $ldap_attrs;
310 }
311 2 ▶ if ( defined $sling_attrs ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $sling_attrs) 2 0 2
312 2 @{$sling_attrs_array} = split /,/msx, $sling_attrs;
313 }
314 2 ▶ if ( @{$ldap_attrs_array} != @{$sling_attrs_array} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (@{$ldap_attrs_array;} != @{$sling_attrs_array;}) 1 1 2
315 croak
316 q(Number of ldap attributes must match number of sling attributes, )
317 1 . @{$ldap_attrs_array} . ' != '
318 1 . @{$sling_attrs_array};
319 }
320 }
321 2 return 1;
322 }
323  
324 #}}}
325  
326 #{{{sub check_for_property_modifications
327  
328 1 ▶sub check_for_property_modifications {
Subroutine check_for_property_modifications: called CC=4 SCAR=17.9
Pod documented
329 1 my ( $new_properties, $cached_properties ) = @_;
330 1 foreach my $property_key ( keys %{$new_properties} ) {
331 1 ▶ if ( !defined $cached_properties->{$property_key} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $cached_properties->{$property_key}) 1 0 1
332  
333 # Found a newly specified property:
334 1 return 1;
335 }
336 0 ▶ if ( $new_properties->{$property_key} ne
Branch: 1 branch
BranchTrueFalseTotal
if ($new_properties->{$property_key} ne $cached_properties->{$property_key}) 0 0 0
337 $cached_properties->{$property_key} )
338 {
339  
340 # Found a modified property:
341 0 return 1;
342 }
343 }
344 0 return 0;
345 }
346  
347 #}}}
348  
349 #{{{sub perform_synchronization
350  
351 0 ▶sub perform_synchronization {
Subroutine perform_synchronization: not called CC=14 SCAR=53.5
Pod documented
352 0 my ( $class, $array_of_dns, $search_result, $seen_user_ids, $synch_cache,
353 $ldap_attrs_array, $sling_attrs_array )
354 = @_;
355 0 foreach my $dn ( @{$array_of_dns} ) {
356 0 my $valref = $search_result->{$dn};
357 0 my $index = 0;
358 0 my $user_id = @{ $valref->{ $class->{'Filter'} } }[0];
359 0 $seen_user_ids->{$user_id} = 1;
360 0 my @properties_array;
361 my %properties_hash;
362 0 foreach my $ldap_attr ( @{$ldap_attrs_array} ) {
363 0 my $value = @{ $valref->{$ldap_attr} }[0];
364 0 ▶ if ( defined $value ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value) 0 0 0
365 push @properties_array,
366 0 @{$sling_attrs_array}[$index] . q(=) . $value;
367 0 $properties_hash{ @{$sling_attrs_array}[$index] } = $value;
368 }
369 0 $index++;
370 }
371 0 ▶ if ( defined $synch_cache->{$user_id} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $synch_cache->{$user_id}) { } 0 0 0
372  
373 # We already know about this user from a previous run:
374 0 ▶ if ( $synch_cache->{$user_id}->{ $class->{'Disabled'} } eq '1' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($synch_cache->{$user_id}{$class->{'Disabled'}} eq '1') { } 0 0 0
375  
376 # User was previously disabled. Re-enabling:
377 0 push @properties_array, $class->{'Disabled'} . '=0';
378 0 ▶ print "Re-enabling previously disabled user: $user_id\n"
Branch: 1 branch
BranchTrueFalseTotal
print "Re-enabling previously disabled user: $user_id\n" or croak("Problem printing!") 0 0 0
379 or croak q{Problem printing!};
380 0 ▶ ${ $class->{'User'} }->update( $user_id, \@properties_array )
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"User"};}->update($user_id, \@properties_array) or croak("Problem re-enabling user in sling instance!") 0 0 0
381 or croak q(Problem re-enabling user in sling instance!);
382 0 $synch_cache->{$user_id} = \%properties_hash;
383 0 $synch_cache->{$user_id}->{ $class->{'Disabled'} } = '0';
384 }
385 else {
386  
387 # User is enabled in sling already, check for modifications:
388 0 ▶ if (
Branch: 1 branch
BranchTrueFalseTotal
if (check_for_property_modifications(\%properties_hash, \%{$$synch_cache{$user_id};})) { } 0 0 0
389 check_for_property_modifications(
390 0 \%properties_hash, \%{ $synch_cache->{$user_id} }
391 )
392 )
393 {
394  
395 # Modifications are present, so we need to update:
396 0 ▶ print "Updating existing user $user_id\n"
Branch: 1 branch
BranchTrueFalseTotal
print "Updating existing user $user_id\n" or croak("Problem printing!") 0 0 0
397 or croak q{Problem printing!};
398 0 ▶ ${ $class->{'User'} }
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"User"};}->update($user_id, \@properties_array) or croak("Problem updating user in sling instance!") 0 0 0
399 ->update( $user_id, \@properties_array )
400 or croak q(Problem updating user in sling instance!);
401 0 $properties_hash{ $class->{'Disabled'} } = '0';
402 0 $synch_cache->{$user_id} = \%properties_hash;
403 }
404 else {
405  
406 # No modifications present, nothing to do!
407 0 ▶ print "No user modifications, skipping: $user_id\n"
Branch: 1 branch
BranchTrueFalseTotal
print "No user modifications, skipping: $user_id\n" or croak("Problem printing!") 0 0 0
408 or croak q{Problem printing!};
409 }
410 }
411 }
412 else {
413  
414 # We have never seen this user before:
415 0 ▶ print "Creating new user: $user_id\n" or croak q{Problem printing!};
Branch: 1 branch
BranchTrueFalseTotal
print "Creating new user: $user_id\n" or croak("Problem printing!") 0 0 0
416 0 ▶ ${ $class->{'User'} }
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"User"};}->add($user_id, "password", \@properties_array) or croak("Problem adding new user to sling instance!") 0 0 0
417 ->add( $user_id, 'password', \@properties_array )
418 or croak q(Problem adding new user to sling instance!);
419 0 $properties_hash{ $class->{'Disabled'} } = '0';
420 0 $synch_cache->{$user_id} = \%properties_hash;
421 }
422 }
423 0 return 0;
424 }
425  
426 #}}}
427  
428 #{{{sub synch_full
429  
430 0 ▶sub synch_full {
Subroutine synch_full: not called CC=7 SCAR=40.3
Pod documented
431 0 my ( $class, $ldap_attrs, $sling_attrs ) = @_;
432 0 my $search = q{(} . $class->{'Filter'} . q{=*)};
433 0 my @ldap_attrs_array;
434 my @sling_attrs_array;
435 0 ▶ parse_attributes( $ldap_attrs, $sling_attrs, \@ldap_attrs_array,
Branch: 1 branch
BranchTrueFalseTotal
parse_attributes($ldap_attrs, $sling_attrs, \@ldap_attrs_array, \@sling_attrs_array) or croak("Problem parsing attributes!") 0 0 0
436 \@sling_attrs_array )
437 or croak q(Problem parsing attributes!);
438  
439 # We need to capture the id as well as any attributes:
440 0 unshift @ldap_attrs_array, $class->{'Filter'};
441 0 my $search_result = $class->ldap_search( $search, \@ldap_attrs_array );
442 0 shift @ldap_attrs_array;
443  
444 0 my $synch_cache = $class->get_synch_cache;
445 0 my %seen_user_ids;
446  
447 # process each DN using it as a key
448 0 my @array_of_dns = sort keys %{$search_result};
449  
450 0 $class->perform_synchronization(
451 \@array_of_dns, $search_result, \%seen_user_ids,
452 $synch_cache, \@ldap_attrs_array, \@sling_attrs_array
453 );
454  
455 # Clean up records no longer in ldap:
456 0 my @disable_property;
457 0 push @disable_property, $class->{'Disabled'} . '=1';
458 0 foreach my $cache_entry ( sort keys %{$synch_cache} ) {
459 0 ▶ if ( $synch_cache->{$cache_entry}->{ $class->{'Disabled'} } eq '0'
Branch: 1 branch
BranchTrueFalseTotal
if ($synch_cache->{$cache_entry}{$class->{"Disabled"}} eq 0 and not defined $seen_user_ids{$cache_entry}) 0 0 0
Condition0%0/3
$synch_cache->{$cache_entry}{$class->{"Disabled"}} eq 0 and not defined $seen_user_ids{$cache_entry}
!ll&&!rl&&r
000
MC/DC0%0/2
$synch_cache->{$cache_entry}{$class->{"Disabled"}} eq 0 and not defined $seen_user_ids{$cache_entry}
$synch_cache->{$cache_entry}{$class->{"Disabled"}} eq 0 not defined $seen_user_ids{$cache_entry}
Truth table0%0/3
A and not(B)
A= $synch_cache->{$cache_entry}{$class->{"Disabled"}} eq 0B= not defined $seen_user_ids{$cache_entry}
ABresult
0X0
100
111
460 && !defined $seen_user_ids{$cache_entry} )
461 {
462 0 ▶ print
Branch: 1 branch
BranchTrueFalseTotal
print "Disabling user record in sling that no longer exists in ldap: $cache_entry\n" or croak("Problem printing!") 0 0 0
463 "Disabling user record in sling that no longer exists in ldap: $cache_entry\n"
464 or croak q{Problem printing!};
465 0 ▶ ${ $class->{'User'} }->update( $cache_entry, \@disable_property )
Branch: 1 branch
BranchTrueFalseTotal
${$$class{"User"};}->update($cache_entry, \@disable_property) or croak("Problem disabling user in sling instance!") 0 0 0
466 or croak q(Problem disabling user in sling instance!);
467 0 $synch_cache->{$cache_entry}->{ $class->{'Disabled'} } = '1';
468 }
469 }
470 0 $class->update_synch_cache($synch_cache);
471  
472 0 $class->{'Message'} = 'Successfully performed a full synchronization!';
473 0 return 1;
474 }
475  
476 #}}}
477  
478 #{{{sub synch_full_since
479  
480 0 ▶sub synch_full_since {
Subroutine synch_full_since: not called CC=1 SCAR=6.9
Pod documented
481 0 my ( $class, $ldap_attrs, $sling_attrs, $synch_since ) = @_;
482 0 my $search = q{(modifytimestamp>=} . $synch_since . q{)};
483 0 my $search_result = $class->ldap_search( $search, $ldap_attrs );
484 0 croak q(Function not yet fully supported!);
485  
486 # return 1;
487 }
488  
489 #}}}
490  
491 #{{{sub synch_listed
492  
493 0 ▶sub synch_listed {
Subroutine synch_listed: not called CC=1 SCAR=6.9
Pod documented
494 0 my ( $class, $ldap_attrs, $sling_attrs ) = @_;
495 0 my $search = q{(} . $class->{'Filter'} . q{=*)};
496 0 my $search_result = $class->ldap_search( $search, $ldap_attrs );
497 0 croak q(Function not yet fully supported!);
498  
499 # return 1;
500 }
501  
502 #}}}
503  
504 #{{{sub synch_listed_since
505  
506 0 ▶sub synch_listed_since {
Subroutine synch_listed_since: not called CC=1 SCAR=6.9
Pod documented
507 0 my ( $class, $ldap_attrs, $sling_attrs, $synch_since ) = @_;
508 0 my $search = q{(} . $class->{'Filter'} . q{=*)};
509 0 my $search_result = $class->ldap_search( $search, $ldap_attrs );
510 0 croak q(Function not yet fully supported!);
511  
512 # return 1;
513 }
514  
515 #}}}
516  
517 #{{{ sub command_line
518 0 ▶sub command_line {
Subroutine command_line: not called CC=1 SCAR=6.9
Pod undocumented
519 0 my ( $ldap_synch, @ARGV ) = @_;
520 0 my $sling = Apache::Sling->new;
521 0 my $config = $ldap_synch->config( $sling, @ARGV );
522 0 return $ldap_synch->run( $sling, $config );
523 }
524  
525 #}}}
526  
527 #{{{sub config
528  
529 1 ▶sub config {
Subroutine config: called CC=2 SCAR=7.0
Pod documented
530 1 my ( $ldap_synch, $sling, @ARGV ) = @_;
531 1 my $ldap_synch_config = $ldap_synch->config_hash( $sling, @ARGV );
532  
533 1 ▶ GetOptions(
Branch: 1 branch
BranchTrueFalseTotal
&GetOptions($ldap_synch_config, "auth=s", "help|?", "log|L=s", "man|M", "pass|p=s", "threads|t=s", "url|U=s", "user|u=s", "verbose|v+", "download-user-list", "ldap-attributes|a=s", "ldap-base|b=s", "ldap-dn|d=s", "ldap-filter|f=s", "ldap-host|h=s", "ldap-pass|P=s", "attributes|A=s", "synch-full|s", "synch-full-since|S=s", "synch-listed|l", "synch-listed-since", "upload-user-list") or $ldap_synch->help 1 0 1
534 $ldap_synch_config, 'auth=s',
535 'help|?', 'log|L=s',
536 'man|M', 'pass|p=s',
537 'threads|t=s', 'url|U=s',
538 'user|u=s', 'verbose|v+',
539 'download-user-list', 'ldap-attributes|a=s',
540 'ldap-base|b=s', 'ldap-dn|d=s',
541 'ldap-filter|f=s', 'ldap-host|h=s',
542 'ldap-pass|P=s', 'attributes|A=s',
543 'synch-full|s', 'synch-full-since|S=s',
544 'synch-listed|l', 'synch-listed-since',
545 'upload-user-list'
546 ) or $ldap_synch->help();
547  
548 1 return $ldap_synch_config;
549 }
550  
551 #}}}
552  
553 #{{{sub config_hash
554  
555 1 ▶sub config_hash {
Subroutine config_hash: called CC=1 SCAR=0.0
Pod undocumented
556 1 my ( $ldap_synch, $sling, @ARGV ) = @_;
557 1 my $attributes;
558 my $download_user_list;
559 1 my $flag_disabled;
560 1 my $ldap_attributes;
561 1 my $ldap_base;
562 1 my $ldap_dn;
563 1 my $ldap_filter;
564 1 my $ldap_host;
565 1 my $ldap_pass;
566 1 my $synch_full;
567 1 my $synch_full_since;
568 1 my $synch_listed;
569 1 my $synch_listed_since;
570 1 my $upload_user_list;
571  
572 my %ldap_synch_config = (
573 'auth' => \$sling->{'Auth'},
574 'help' => \$sling->{'Help'},
575 'log' => \$sling->{'Log'},
576 'man' => \$sling->{'Man'},
577 'pass' => \$sling->{'Pass'},
578 'threads' => \$sling->{'Threads'},
579 'url' => \$sling->{'URL'},
580 'user' => \$sling->{'User'},
581 1 'verbose' => \$sling->{'Verbose'},
582 'attributes' => $attributes,
583 'download-user-list' => $download_user_list,
584 'flag-disabled' => $flag_disabled,
585 'ldap-attributes' => $ldap_attributes,
586 'ldap-base' => $ldap_base,
587 'ldap-dn' => $ldap_dn,
588 'ldap-filter' => $ldap_filter,
589 'ldap-host' => $ldap_host,
590 'ldap-pass' => $ldap_pass,
591 'synch-full' => $synch_full,
592 'synch-full-since' => $synch_full_since,
593 'synch-listed' => $synch_listed,
594 'synch-listed-since' => $synch_listed_since,
595 'upload-user-list' => $upload_user_list
596 );
597  
598 1 return \%ldap_synch_config;
599 }
600  
601 #}}}
602  
603 #{{{ sub help
604 1 ▶sub help {
Subroutine help: called CC=1 SCAR=0.0
Pod undocumented
605  
606 1 print <<"EOF";
607 Usage: perl $0 [-OPTIONS [-MORE_OPTIONS]] [--] [PROGRAM_ARG1 ...]
608 The following options are accepted:
609  
610 --attributes or -a (attribs) - Comma separated list of attributes.
611 --auth (type) - Specify auth type. If ommitted, default is used.
612 --download-user-list (userList) - Download user list to file userList
613 --flag-disabled or -f - property to denote user should be disabled.
614 --help or -? - View the script synopsis and options.
615 --ldap-attributes or -A (attribs) - Specify ldap attributes to be updated.
616 --ldap-base or -B (ldapBase) - Specify ldap base to synchronize users from.
617 --ldap-dn or -D (ldapDN) - Specify ldap DN for authentication.
618 --ldap-filter or -F (filter) - Specify ldap attribute to search for users with.
619 --ldap-host or -H (host) - Specify ldap host to synchronize from.
620 --ldap-pass or -P (pass) - Specify ldap pass for authentication.
621 --log or -L (log) - Log script output to specified log file.
622 --man or -M - View the full script documentation.
623 --pass or -p (password) - Password of user performing actions.
624 --synch-full or -s - Perform a full synchronization from ldap to sling.
625 --synch-full-since or -S (since) - Perform a full synchronization from ldap to sling using changes since specified time.
626 --synch-listed or -l - Perform a sychronization of listed users from ldap to sling.
627 --synch-listed-since (since) - Perform a sychronization of listed users from ldap to sling using changes since specified time.
628 --upload-user-list (userList) - Upload user list specified by file userList.
629 --url or -U (URL) - URL for system being tested against.
630 --user or -u (username) - Name of user to perform any actions as.
631 --verbose or -v or -vv or -vvv - Increase verbosity of output.
632  
633 Options may be merged together. -- stops processing of options.
634 Space is not required between options and their arguments.
635 For full details run: perl $0 --man
636 EOF
637  
638 1 return 1;
639 }
640  
641 #}}}
642  
643 #{{{ sub man
644 0 ▶sub man {
Subroutine man: not called CC=1 SCAR=6.9
Pod undocumented
645  
646 0 my ($ldap_synch) = @_;
647  
648 0 print <<'EOF';
649 LDAP synchronization perl script. Provides a means of synchronizing user
650 information from an LDAP server into a running sling instance from the command
651 line. The script also acts as a reference implementation for the LDAPSynch perl
652 library.
653  
654 EOF
655  
656 0 $ldap_synch->help();
657  
658 0 print <<"EOF";
659 Example Usage
660  
661 * Upload a restricted list of users (one id per line of specified file) to use in synchronizations:
662  
663 perl $0 --upload-user-list user_list.txt --sling-host http://localhost:8080 --sling-user admin --sling-pass admin
664  
665 * Download a previously specified list of users to be synchronized to a specified file:
666  
667 perl $0 --download-user-list user_list.txt --sling-host http://localhost:8080 --sling-user admin --sling-pass admin
668  
669 * Authenticate and perform a full synchronization:
670  
671 perl $0 -s -h ldap://ldap.org -b "ou=people,o=ldap,dc=org" -H http://localhost:8080 -u admin -P admin -a "displayname,mail,sn" -A "name,email,surname"
672 EOF
673  
674 0 return 1;
675 }
676  
677 #}}}
678  
679 #{{{sub run
680 2 ▶sub run {
Subroutine run: called CC=10 SCAR=39.1
Pod documented
681 2 my ( $ldap_synch, $sling, $config ) = @_;
682 2 ▶ if ( !defined $config ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $config) 1 1 2
683 1 croak 'No ldap_synch config supplied!';
684 }
685 1 $sling->check_forks;
686  
687 1 my $authn = new Apache::Sling::Authn( \$sling );
688 1 $authn->login_user();
689  
690 1 my $success = 1;
691  
692 0 ▶ if ( $sling->{'Help'} ) { $ldap_synch->help(); }
Branch: 8 branches
BranchTrueFalseTotal
if ($sling->{'Help'}) { } 0 1 1
elsif ($sling->{'Man'}) { } 0 1 1
elsif (defined ${$$config{'download-user-list'};}) { } 0 1 1
elsif (defined ${$$config{'upload-user-list'};}) { } 0 1 1
elsif (defined ${$$config{'synch-full'};}) { } 0 1 1
elsif (defined ${$$config{'synch-full-since'};}) { } 0 1 1
elsif (defined ${$$config{'synch-listed'};}) { } 0 1 1
elsif (defined ${$$config{'synch-listed-since'};}) { } 0 1 1
693 0 elsif ( $sling->{'Man'} ) { $ldap_synch->man(); }
694 1 elsif ( defined ${ $config->{'download-user-list'} } ) {
695 $ldap_synch = new Apache::Sling::LDAPSynch(
696 0 ${ $config->{'ldap-host'} },
697 0 ${ $config->{'ldap-base'} },
698 0 ${ $config->{'ldap-filter'} },
699 0 ${ $config->{'ldap-dn'} },
700 0 ${ $config->{'ldap-pass'} },
701 \$authn,
702 0 ${ $config->{'flag-disabled'} },
703 $sling->{'Verbose'},
704 0 $sling->{'Log'}
705 );
706 $success = $ldap_synch->download_synch_user_list(
707 0 ${ $config->{'download-user-list'} } );
708 }
709 1 elsif ( defined ${ $config->{'upload-user-list'} } ) {
710 $ldap_synch = new Apache::Sling::LDAPSynch(
711 0 ${ $config->{'ldap-host'} },
712 0 ${ $config->{'ldap-base'} },
713 0 ${ $config->{'ldap-filter'} },
714 0 ${ $config->{'ldap-dn'} },
715 0 ${ $config->{'ldap-pass'} },
716 \$authn,
717 0 ${ $config->{'flag-disabled'} },
718 $sling->{'Verbose'},
719 0 $sling->{'Log'}
720 );
721 $success = $ldap_synch->upload_synch_user_list(
722 0 ${ $config->{'upload-user-list'} } );
723 }
724 1 elsif ( defined ${ $config->{'synch-full'} } ) {
725 $ldap_synch = new Apache::Sling::LDAPSynch(
726 0 ${ $config->{'ldap-host'} },
727 0 ${ $config->{'ldap-base'} },
728 0 ${ $config->{'ldap-filter'} },
729 0 ${ $config->{'ldap-dn'} },
730 0 ${ $config->{'ldap-pass'} },
731 \$authn,
732 0 ${ $config->{'flag-disabled'} },
733 $sling->{'Verbose'},
734 0 $sling->{'Log'}
735 );
736 0 $success = $ldap_synch->synch_full( ${ $config->{'ldap-attributes'} },
737 0 ${ $config->{'attributes'} } );
738 }
739 1 elsif ( defined ${ $config->{'synch-full-since'} } ) {
740 $ldap_synch = new Apache::Sling::LDAPSynch(
741 0 ${ $config->{'ldap-host'} },
742 0 ${ $config->{'ldap-base'} },
743 0 ${ $config->{'ldap-filter'} },
744 0 ${ $config->{'ldap-dn'} },
745 0 ${ $config->{'ldap-pass'} },
746 \$authn,
747 0 ${ $config->{'flag-disabled'} },
748 $sling->{'Verbose'},
749 0 $sling->{'Log'}
750 );
751 $success = $ldap_synch->synch_full_since(
752 0 ${ $config->{'ldap-attributes'} },
753 0 ${ $config->{'attributes'} },
754 0 ${ $config->{'synch-full-since'} }
755 );
756 }
757 1 elsif ( defined ${ $config->{'synch-listed'} } ) {
758 $ldap_synch = new Apache::Sling::LDAPSynch(
759 0 ${ $config->{'ldap-host'} },
760 0 ${ $config->{'ldap-base'} },
761 0 ${ $config->{'ldap-filter'} },
762 0 ${ $config->{'ldap-dn'} },
763 0 ${ $config->{'ldap-pass'} },
764 \$authn,
765 0 ${ $config->{'flag-disabled'} },
766 $sling->{'Verbose'},
767 0 $sling->{'Log'}
768 );
769 0 $success = $ldap_synch->synch_listed( ${ $config->{'ldap-attributes'} },
770 0 ${ $config->{'attributes'} } );
771 }
772 1 elsif ( defined ${ $config->{'synch-listed-since'} } ) {
773 $ldap_synch = new Apache::Sling::LDAPSynch(
774 0 ${ $config->{'ldap-host'} },
775 0 ${ $config->{'ldap-base'} },
776 0 ${ $config->{'ldap-filter'} },
777 0 ${ $config->{'ldap-dn'} },
778 0 ${ $config->{'ldap-pass'} },
779 \$authn,
780 0 ${ $config->{'flag-disabled'} },
781 $sling->{'Verbose'},
782 0 $sling->{'Log'}
783 );
784 $success = $ldap_synch->synch_listed_since(
785 0 ${ $config->{'ldap-attributes'} },
786 0 ${ $config->{'attributes'} },
787 0 ${ $config->{'synch-listed-since'} }
788 );
789 }
790 else {
791 1 $ldap_synch->help();
792 1 return 1;
793 }
794 0 Apache::Sling::Print::print_result($ldap_synch);
795 0 return $success;
796 }
797  
798 #}}}
799  
800 1 1;
801  
802 __END__
« Sling/Authz.pm ↑ Summary Sling/User.pm »