6 use LiCoM::Config (qw(get_config));
13 Person - High level interface for address books using an LDAP-backend.
20 facsimileTelephoneNumber => 1,
25 homePostalAddress => 1,
34 officephone => 'telephoneNumber',
35 fax => 'facsimileTelephoneNumber',
38 firstname => 'givenName',
39 homephone => 'homePhone',
40 address => 'homePostalAddress',
43 cellphone => 'mobile',
44 password => 'userPassword'
51 =head1 STATIC FUNCTIONS
55 =item LiCoM::Person-E<gt>B<load> (I<$cn>)
57 Loads the given CN and returns the B<Person>-object.
66 my ($retval) = search ($pkg, [[cn => $cn]]);
70 warn ("CN '$cn' could not be found");
77 =item LiCoM::Person-E<gt>B<create> (B<lastname> =E<gt> I<$lastname>, B<firstname> =E<gt> I<$firstname>, ...)
79 Create a new I<Net::LDAP::Entry>-object and return it's corresponding
89 my $entry = Net::LDAP::Entry->new ();
92 $entry->add (objectClass => [qw(top organizationalUnit person organizationalPerson inetOrgPerson)]);
97 my $val = $hash{$key};
98 my $field = defined ($ExternalNames{$key}) ? $ExternalNames{$key} : $key;
100 if (!defined ($ValidFields{$field}))
102 warn ("Invalid field $field");
106 if ($ValidFields{$field})
108 if (ref ($val) eq 'ARRAY')
110 $entry->add ($field => [@$val]) if (@$val);
114 $entry->add ($field => [$val]) if ($val);
118 warn ("You cannot pass ref-type " . ref ($val));
124 if (ref ($val) eq 'ARRAY')
134 warn ("You cannot pass ref-type " . ref ($val));
137 $entry->add ($field => $val) if (defined ($val) and $val);
141 my $sn = $entry->get_value ('sn');
142 my $gn = $entry->get_value ('givenName');
144 if (!defined ($sn) or !defined ($gn))
146 warn ("sn or givenName not given");
150 $dn = "cn=$sn $gn," . get_config ('base_dn');
152 $entry->add (cn => "$sn $gn");
155 $entry->changetype ('add');
156 my $mesg = $entry->update ($Ldap);
158 if ($mesg->is_error ())
160 warn ("Error while creating entry '$dn' on LDAP server: " . $mesg->error_text ());
164 return (new ($pkg, $entry));
167 =item LiCoM::Person-E<gt>B<search> (B<firstname> =E<gt> I<"Flor*">)
169 Search for the given patterns. Returns a list of I<Person>-objects.
174 [field => value], # OR
203 $field = $ExternalNames{$field} if (defined ($ExternalNames{$field}));
204 if (!defined ($ValidFields{$field}))
206 warn ("Not a valid field: $field");
210 $value =~ s/([\(\)\\])/\\$1/g;
212 push (@disjunc, "($field=$value)");
218 if (scalar (@disjunc) == 1)
224 $tmp = join ('', '(|', @disjunc, ')');
226 push (@konjunct, $tmp);
232 $filter = join ('', '(&(objectclass=inetOrgPerson)', @konjunct, ')');
236 $filter = '(objectclass=inetOrgPerson)';
239 $mesg = $Ldap->search
241 base => get_config ('base_dn'),
245 if ($mesg->is_error ())
247 warn ("Error while querying LDAP server: " . $mesg->error_text ());
251 for ($mesg->entries ())
254 my $obj = new ($pkg, $entry);
256 push (@retval, $obj);
262 =item LiCoM::Person-E<gt>B<get_user> (I<$dn>)
264 Returns the cn and, if defined, the user-id of this dn.
272 my ($search) = $dn =~ m/cn\s*=\s*([^,]+)/i;
274 die unless ($search);
279 my $mesg = $Ldap->search
281 base => get_config ('base_dn'),
282 filter => "(cn=$search)"
285 if ($mesg->is_error ())
287 warn ("Error while querying LDAP server: " . $mesg->error_text ());
291 for ($mesg->entries ())
294 my ($t_cn) = $e->get_value ('cn', asref => 0);
295 my ($t_id) = $e->get_value ('uid', asref => 0);
313 =item I<$obj>-E<gt>B<delete> ()
322 my $entry = $obj->{'ldap'};
324 $entry->changetype ('delete');
326 $entry->update ($Ldap);
331 =item I<$obj>-E<gt>B<lastname> ([I<$lastname>])
333 Get or set the lastname.
340 my $entry = $obj->{'ldap'};
341 my $sn = $obj->{'sn'};
342 my $gn = $obj->{'givenName'};
344 my $dn = "cn=$cn," . get_config ('base_dn');
348 print STDERR "This is _update_dn, trying to set dn=$dn";
350 $entry->changetype ('modify');
351 $entry->replace (sn => $sn, givenName => $gn, cn => $cn);
352 $entry->update ($Ldap);
354 $entry->update ($Ldap);
363 $obj->{'sn'} = shift;
367 return ($obj->{'sn'});
370 =item I<$obj>-E<gt>B<firstname> ([I<$firstname>])
372 Get or set the firstname.
382 $obj->{'givenName'} = shift;
386 return ($obj->{'givenName'});
389 =item I<$obj>-E<gt>B<name> ()
398 return ($obj->{'cn'});
401 =item I<$obj>-E<gt>B<address> ([I<@address>])
403 =item I<$obj>-E<gt>B<homephone> ([I<@homephone>])
405 =item I<$obj>-E<gt>B<cellphone> ([I<@cellphone>])
407 =item I<$obj>-E<gt>B<officephone> ([I<@officephone>])
409 =item I<$obj>-E<gt>B<fax> ([I<@fax>])
411 =item I<$obj>-E<gt>B<mail> ([I<@mail>])
413 =item I<$obj>-E<gt>B<uri> ([I<@uri>])
415 =item I<$obj>-E<gt>B<group> ([I<@groups>])
417 Get or set the attribute. This is the same as calling S<I<$obj>-E<gt>B<set>
418 (I<$field>, I<\@values>)> or S<I<$obj>-E<gt>B<get> (I<$field>)>.
426 my $field = $Person::AUTOLOAD;
428 return (undef) unless ($field);
432 return (set ($obj, $field, @values ? [@values] : undef))
435 =item I<$obj>-E<gt>B<get> (I<$field>)
437 Returs the value(s) of field I<$field>.
448 return (set ($obj, $field, undef));
452 return (scalar (set ($obj, $field, undef)));
456 =item I<$obj>-E<gt>B<set> (I<$field>, I<\@values>)
458 Sets the field I<$field> to the value(s) I<\@valued>. Pass an empty array-ref
467 my $value = @_ ? shift : undef;
468 my $entry = $obj->{'ldap'};
470 if (defined ($ExternalNames{$field}))
472 $field = $ExternalNames{$field};
474 if (!defined ($ValidFields{$field}))
479 if (defined ($value))
481 $entry->changetype ('modify');
483 if ($ValidFields{$field})
485 $entry->replace ($field, [@$value]);
486 $obj->{$field} = $value;
490 splice (@$value, 1) if (scalar (@$value) > 1);
491 $entry->replace ($field, $value);
492 $obj->{$field} = $value->[0];
495 $entry->update ($Ldap);
498 $obj->{$field} = [] unless (defined ($obj->{$field}));
500 if (wantarray () and $ValidFields{$field})
502 return (@{$obj->{$field}});
506 return ($obj->{$field});
514 Florian octo Forster E<lt>octo at verplant.orgE<gt>