6 use LiCoM::Config (qw(get_config));
7 use LiCoM::Connection (qw($Ldap));
10 use Net::LDAP::Filter;
14 Person - High level interface for address books using an LDAP-backend.
21 facsimileTelephoneNumber => 1,
26 homePostalAddress => 1,
35 officephone => 'telephoneNumber',
36 fax => 'facsimileTelephoneNumber',
39 firstname => 'givenName',
40 homephone => 'homePhone',
41 address => 'homePostalAddress',
44 cellphone => 'mobile',
45 password => 'userPassword'
50 =head1 STATIC FUNCTIONS
54 =item LiCoM::Person-E<gt>B<load> (I<$cn>)
56 Loads the given CN and returns the B<Person>-object.
65 my ($retval) = search ($pkg, [[cn => $cn]]);
69 warn ("CN '$cn' could not be found");
76 =item LiCoM::Person-E<gt>B<create> (B<lastname> =E<gt> I<$lastname>, B<firstname> =E<gt> I<$firstname>, ...)
78 Create a new I<Net::LDAP::Entry>-object and return it's corresponding
88 my $entry = Net::LDAP::Entry->new ();
91 $entry->add (objectClass => [qw(top organizationalUnit person organizationalPerson inetOrgPerson)]);
96 my $val = $hash{$key};
97 my $field = defined ($ExternalNames{$key}) ? $ExternalNames{$key} : $key;
99 if (!defined ($ValidFields{$field}))
101 warn ("Invalid field $field");
105 if ($ValidFields{$field})
107 if (ref ($val) eq 'ARRAY')
109 $entry->add ($field => [@$val]) if (@$val);
113 $entry->add ($field => [$val]) if ($val);
117 warn ("You cannot pass ref-type " . ref ($val));
123 if (ref ($val) eq 'ARRAY')
133 warn ("You cannot pass ref-type " . ref ($val));
136 $entry->add ($field => $val) if (defined ($val) and $val);
140 my $sn = $entry->get_value ('sn');
141 my $gn = $entry->get_value ('givenName');
143 if (!defined ($sn) or !defined ($gn))
145 warn ("sn or givenName not given");
149 $dn = "cn=$sn $gn," . get_config ('base_dn');
151 $entry->add (cn => "$sn $gn");
154 $entry->changetype ('add');
155 my $mesg = $entry->update ($Ldap);
157 if ($mesg->is_error ())
159 warn ("Error while creating entry '$dn' on LDAP server: " . $mesg->error_text ());
163 return (new ($pkg, $entry));
166 =item LiCoM::Person-E<gt>B<search> (B<firstname> =E<gt> I<"Flor*">)
168 Search for the given patterns. Returns a list of I<Person>-objects.
173 [field => value], # OR
202 $field = $ExternalNames{$field} if (defined ($ExternalNames{$field}));
203 if (!defined ($ValidFields{$field}))
205 warn ("Not a valid field: $field");
209 $value =~ s/([\(\)\\])/\\$1/g;
211 push (@disjunc, "($field=$value)");
217 if (scalar (@disjunc) == 1)
223 $tmp = join ('', '(|', @disjunc, ')');
225 push (@konjunct, $tmp);
231 $filter = join ('', '(&(objectclass=inetOrgPerson)', @konjunct, ')');
235 $filter = '(objectclass=inetOrgPerson)';
238 $mesg = $Ldap->search
240 base => get_config ('base_dn'),
244 if ($mesg->is_error ())
246 warn ("Error while querying LDAP server: " . $mesg->error_text ());
250 for ($mesg->entries ())
253 my $obj = new ($pkg, $entry);
255 push (@retval, $obj);
261 =item LiCoM::Person-E<gt>B<get_user> (I<$dn>)
263 Returns the cn and, if defined, the user-id of this dn.
271 my ($search) = $dn =~ m/cn\s*=\s*([^,]+)/i;
273 die unless ($search);
278 my $mesg = $Ldap->search
280 base => get_config ('base_dn'),
281 filter => "(cn=$search)"
284 if ($mesg->is_error ())
286 warn ("Error while querying LDAP server: " . $mesg->error_text ());
290 for ($mesg->entries ())
293 my ($t_cn) = $e->get_value ('cn', asref => 0);
294 my ($t_id) = $e->get_value ('uid', asref => 0);
312 =item I<$obj>-E<gt>B<delete> ()
321 my $entry = $obj->{'ldap'};
323 $entry->changetype ('delete');
325 $entry->update ($Ldap);
330 =item I<$obj>-E<gt>B<lastname> ([I<$lastname>])
332 Get or set the lastname.
339 my $entry = $obj->{'ldap'};
340 my $sn = $obj->{'sn'};
341 my $gn = $obj->{'givenName'};
343 my $dn = "cn=$cn," . get_config ('base_dn');
347 print STDERR "This is _update_dn, trying to set dn=$dn";
349 $entry->changetype ('modify');
350 $entry->replace (sn => $sn, givenName => $gn, cn => $cn);
351 $entry->update ($Ldap);
353 $entry->update ($Ldap);
362 $obj->{'sn'} = shift;
366 return ($obj->{'sn'});
369 =item I<$obj>-E<gt>B<firstname> ([I<$firstname>])
371 Get or set the firstname.
381 $obj->{'givenName'} = shift;
385 return ($obj->{'givenName'});
388 =item I<$obj>-E<gt>B<name> ()
397 return ($obj->{'cn'});
400 =item I<$obj>-E<gt>B<address> ([I<@address>])
402 =item I<$obj>-E<gt>B<homephone> ([I<@homephone>])
404 =item I<$obj>-E<gt>B<cellphone> ([I<@cellphone>])
406 =item I<$obj>-E<gt>B<officephone> ([I<@officephone>])
408 =item I<$obj>-E<gt>B<fax> ([I<@fax>])
410 =item I<$obj>-E<gt>B<mail> ([I<@mail>])
412 =item I<$obj>-E<gt>B<uri> ([I<@uri>])
414 =item I<$obj>-E<gt>B<group> ([I<@groups>])
416 Get or set the attribute. This is the same as calling S<I<$obj>-E<gt>B<set>
417 (I<$field>, I<\@values>)> or S<I<$obj>-E<gt>B<get> (I<$field>)>.
425 my $field = $Person::AUTOLOAD;
427 return (undef) unless ($field);
431 return (set ($obj, $field, @values ? [@values] : undef))
434 =item I<$obj>-E<gt>B<get> (I<$field>)
436 Returs the value(s) of field I<$field>.
447 return (set ($obj, $field, undef));
451 return (scalar (set ($obj, $field, undef)));
455 =item I<$obj>-E<gt>B<set> (I<$field>, I<\@values>)
457 Sets the field I<$field> to the value(s) I<\@valued>. Pass an empty array-ref
466 my $value = @_ ? shift : undef;
467 my $entry = $obj->{'ldap'};
469 if (defined ($ExternalNames{$field}))
471 $field = $ExternalNames{$field};
473 if (!defined ($ValidFields{$field}))
478 if (defined ($value))
480 $entry->changetype ('modify');
482 if ($ValidFields{$field})
484 $entry->replace ($field, [@$value]);
485 $obj->{$field} = $value;
489 splice (@$value, 1) if (scalar (@$value) > 1);
490 $entry->replace ($field, $value);
491 $obj->{$field} = $value->[0];
494 $entry->update ($Ldap);
497 $obj->{$field} = [] unless (defined ($obj->{$field}));
499 if (wantarray () and $ValidFields{$field})
501 return (@{$obj->{$field}});
505 return ($obj->{$field});
513 Florian octo Forster E<lt>octo at verplant.orgE<gt>