1 |
package A3C::LDAP; |
2 |
|
3 |
use strict; |
4 |
use warnings; |
5 |
|
6 |
use Net::LDAP; |
7 |
use Data::Dump qw/dump/; |
8 |
use base qw(Jifty::Object Class::Accessor::Fast); |
9 |
our @config_fields = qw( server dn password base ); |
10 |
Jifty->log->debug("using fields from configuration: ",dump( @config_fields )); |
11 |
__PACKAGE__->mk_accessors( qw(ldap current_search), @config_fields ); |
12 |
|
13 |
|
14 |
=head1 NAME |
15 |
|
16 |
A3C::LDAP |
17 |
|
18 |
=head1 DESCRIPTION |
19 |
|
20 |
This object turn L<Net::LDAP> into something with looks like |
21 |
L<Jifty::Collection> |
22 |
|
23 |
=head1 METHODS |
24 |
|
25 |
=head2 new |
26 |
|
27 |
my $ldap = A3C::LDAP->new; |
28 |
|
29 |
=cut |
30 |
|
31 |
sub new { |
32 |
my $class = shift; |
33 |
|
34 |
my $args = { @_ }; |
35 |
|
36 |
my $ldap_config = Jifty->config->app('LDAP'); |
37 |
Jifty->log->debug( "config->app(LDAP) = ",dump( $ldap_config ) ); |
38 |
|
39 |
foreach my $f ( @config_fields ) { |
40 |
if ( my $v = $ldap_config->{$f} ) { |
41 |
$args->{$f} = $v; |
42 |
} |
43 |
} |
44 |
|
45 |
my $ldap = Net::LDAP->new( $args->{server} ) or die "$@"; |
46 |
|
47 |
# an anonymous bind |
48 |
#$ldap->bind; |
49 |
$ldap->bind( $args->{dn}, password => $args->{password} ); |
50 |
|
51 |
Jifty->log->info("Connected to ", $args->{server}, " with DN ", $args->{dn}); |
52 |
|
53 |
$args->{ldap} = $ldap; |
54 |
|
55 |
$class->SUPER::new( $args ); |
56 |
} |
57 |
|
58 |
=head2 search |
59 |
|
60 |
my $msg = A3C::LDAP->search( |
61 |
base => 'dc=skole,dc=hr', |
62 |
filter => '(objectClass=hrEduOrg)', |
63 |
sizelimit => 10, |
64 |
); |
65 |
|
66 |
=cut |
67 |
|
68 |
sub search { |
69 |
my $self = shift; |
70 |
|
71 |
my $search = $self->ldap->search( @_ ); |
72 |
if ( $search->code != 0 ) { |
73 |
Jifty->log->error( $search->error, ' for ', dump( @_ ) ); |
74 |
} |
75 |
return $self->current_search( $search ); |
76 |
} |
77 |
|
78 |
=head2 next |
79 |
|
80 |
Syntaxtic shugar to look more like L<Jifty::DBI::Collection> |
81 |
|
82 |
my $entry = ldap->next; |
83 |
|
84 |
=cut |
85 |
|
86 |
sub next { |
87 |
my $self = shift; |
88 |
|
89 |
die "no current LDAP search" unless $self->current_search; |
90 |
|
91 |
return $self->current_search->shift_entry; |
92 |
} |
93 |
|
94 |
=head2 count |
95 |
|
96 |
my $search_results = $ldap->count; |
97 |
|
98 |
=cut |
99 |
|
100 |
sub count { |
101 |
my $self = shift; |
102 |
$self->current_search->count; |
103 |
} |
104 |
|
105 |
=head2 as_collection_of |
106 |
|
107 |
my $connection = $ldap->collection( |
108 |
# name of model to use |
109 |
'Organization', |
110 |
# optional params |
111 |
limit => $limit, |
112 |
filter => '(uid=foobar)', |
113 |
); |
114 |
|
115 |
=cut |
116 |
|
117 |
my $collection2filter = { |
118 |
'User' => '(objectClass=hrEduPerson)', |
119 |
'Organization' => '(objectClass=hrEduOrg)', |
120 |
}; |
121 |
|
122 |
sub collection { |
123 |
my $self = shift; |
124 |
my $model = shift or die "no model?"; |
125 |
my $args = {@_}; |
126 |
|
127 |
$args->{limit} ||= 0; # unlimited by default |
128 |
|
129 |
my $filter = $collection2filter->{$model}; |
130 |
die "unknown model $model" unless $filter; |
131 |
|
132 |
# add user filter |
133 |
$filter = '(&' . $filter . $args->{filter} . ')' if $args->{filter}; |
134 |
|
135 |
$self->search( |
136 |
base => $self->base, |
137 |
filter => $filter, |
138 |
sizelimit => $args->{limit}, |
139 |
); |
140 |
|
141 |
Jifty->log->info( |
142 |
"Searching LDAP for $model with $filter ", |
143 |
$args->{limit} ? 'limit ' . $args->{limit} . ' ' : '', |
144 |
'returned ', $self->count, ' results' |
145 |
); |
146 |
|
147 |
my $class = Jifty->app_class('Model', $model . 'Collection' ) or die "can't create ${model}Collection"; |
148 |
my $collection = $class->new() or die "can't $class->new"; |
149 |
|
150 |
while ( my $entry = $self->next ) { |
151 |
my $model_obj = Jifty->app_class('Model',$model)->new; |
152 |
#warn dump( $model_obj ); |
153 |
my $additional; |
154 |
# if ( $model eq 'User' ) { |
155 |
# my $organization = A3C::Model::Organization->new; |
156 |
# $self->ldap2model( $organization, $entry ); |
157 |
# $additional->{organization} = $organization; |
158 |
# } |
159 |
$self->ldap2model( $model_obj, $entry, %$additional ); |
160 |
$collection->add_record( $model_obj ); |
161 |
} |
162 |
|
163 |
return $collection; |
164 |
} |
165 |
|
166 |
=head1 INTERNAL METHODS |
167 |
|
168 |
Following methods map directly into L<Net::LDAP> |
169 |
|
170 |
=head2 current_search |
171 |
|
172 |
Result of last C<< $ldap->search >> request |
173 |
|
174 |
=head2 model_to_entry |
175 |
|
176 |
$ldap->model_to_entry( $model, $entry, $additional ); |
177 |
|
178 |
=cut |
179 |
|
180 |
sub ldap2model { |
181 |
my ( $self, $model, $entry, $additional ) = @_; |
182 |
my $data; |
183 |
|
184 |
my @columns = map { $_->name } $model->columns; |
185 |
#warn "# columns = ",dump( @columns ); |
186 |
|
187 |
foreach my $attr ( $entry->attributes ) { |
188 |
if ( grep(/^\Q$attr\E$/, @columns ) ) { |
189 |
$data->{$attr} = $entry->get_value( $attr ); |
190 |
} elsif ( $attr !~ m/^(objectClass)$/i ) { |
191 |
Jifty->log->warn(ref($model)," doesn't have $attr"); |
192 |
} |
193 |
} |
194 |
|
195 |
Jifty->log->debug( ref($model), ' = ', dump( $data ) ); |
196 |
|
197 |
my ( $id, $message ) = $model->load_or_create( %$data, %$additional ); |
198 |
|
199 |
if ( $id ) { |
200 |
Jifty->log->info( $message || 'Added', ' ', ref($model), ' ', $model->id, ' ', $model->name ); |
201 |
} else { |
202 |
Jifty->log->error( ref($model), " ", $message ); |
203 |
} |
204 |
} |
205 |
|
206 |
|
207 |
|
208 |
1; |