11 Person - High level interface for address books using an LDAP-backend.
23 facsimileTelephoneNumber => 1,
28 homePostalAddress => 1,
38 officephone => 'telephoneNumber',
39 fax => 'facsimileTelephoneNumber',
42 firstname => 'givenName',
43 homephone => 'homePhone',
44 address => 'homePostalAddress',
47 cellphone => 'mobile',
49 password => 'userPassword'
60 =item Person-E<gt>B<connect> (I<$server>, I<$bind_dn>, I<$password>, I<$base_dn>, [I<$port>])
62 Connects to the LDAP-Server given.
71 my $bind_dn = $opts{'bind_dn'};
72 my $base_dn = $opts{'base_dn'};
73 my $uri = $opts{'uri'};
74 my $passwd = $opts{'password'};
78 $Ldap = Net::LDAP->new ($uri);
80 $msg = $Ldap->bind ($bind_dn, password => $passwd);
81 if ($msg->is_error ())
83 warn ('LDAP bind failed: ' . $msg->error_text ());
87 $Config{'base_dn'} = $base_dn;
92 =item Person-E<gt>B<disconnect> ()
94 Disconnect from the LDAP-Server.
104 =item Person-E<gt>B<new> (I<$ldap_entry>)
106 Created a new I<Person>-object from the passed I<Net::LDAP::Entry>-object.
116 $obj->{'dn'} = $entry->dn ();
117 $obj->{'ldap'} = $entry;
119 for (keys %ValidFields)
122 $obj->{$key} = $entry->get_value ($key, asref => $ValidFields{$key});
125 return (bless ($obj, $pkg));
128 =item Person-E<gt>B<load> (I<$cn>)
130 Loads the given CN and returns the B<Person>-object.
139 my ($retval) = search ($pkg, [[cn => $cn]]);
143 warn ("CN '$cn' could not be found");
150 =item Person-E<gt>B<create> (B<lastname> =E<gt> I<$lastname>, B<firstname> =E<gt> I<$firstname>, ...)
152 Create a new I<Net::LDAP::Entry>-object and return it's corresponding
162 my $entry = Net::LDAP::Entry->new ();
166 $entry->add (objectClass => [qw(top organizationalUnit person organizationalPerson inetOrgPerson)]);
171 my $val = $hash{$key};
172 my $field = defined ($ExternalNames{$key}) ? $ExternalNames{$key} : $key;
174 if (!defined ($ValidFields{$field}))
176 warn ("Invalid field $field");
180 if ($ValidFields{$field})
182 if (ref ($val) eq 'ARRAY')
184 $entry->add ($field => [@$val]) if (@$val);
188 $entry->add ($field => [$val]) if ($val);
192 warn ("You cannot pass ref-type " . ref ($val));
198 if (ref ($val) eq 'ARRAY')
208 warn ("You cannot pass ref-type " . ref ($val));
211 $entry->add ($field => $val) if (defined ($val) and $val);
215 my $sn = $entry->get_value ('sn');
216 my $gn = $entry->get_value ('givenName');
218 if (!defined ($sn) or !defined ($gn))
220 warn ("sn or givenName not given");
224 $dn = "cn=$sn $gn," . $Config{'base_dn'};
225 ($ou) = $Config{'base_dn'} =~ m/\bou\s*=\s*([^,]+)/i;
227 $entry->add (cn => "$sn $gn", ou => $ou);
231 $entry->dump (*STDOUT);
234 $entry->changetype ('add');
235 my $mesg = $entry->update ($Ldap);
237 if ($mesg->is_error ())
239 warn ("Error while creating entry '$dn' on LDAP server: " . $mesg->error_text ());
243 return (new ($pkg, $entry));
246 =item Person-E<gt>B<search> (B<firstname> =E<gt> I<"Flor*">)
248 Search for the given patterns. Returns a list of I<Person>-objects.
253 [field => value], # OR
282 $field = $ExternalNames{$field} if (defined ($ExternalNames{$field}));
283 if (!defined ($ValidFields{$field}))
285 warn ("Not a valid field: $field");
289 $value =~ s/([\(\)\\])/\\$1/g;
291 push (@disjunc, "($field=$value)");
297 if (scalar (@disjunc) == 1)
303 $tmp = join ('', '(|', @disjunc, ')');
305 push (@konjunct, $tmp);
311 $filter = join ('', '(&(objectclass=inetOrgPerson)', @konjunct, ')');
315 $filter = '(objectclass=inetOrgPerson)';
318 #print STDERR "Debug: using filter: $filter";
320 $mesg = $Ldap->search
322 base => $Config{'base_dn'},
326 if ($mesg->is_error ())
328 warn ("Error while querying LDAP server: " . $mesg->error_text ());
332 for ($mesg->entries ())
335 my $obj = new ($pkg, $entry);
337 push (@retval, $obj);
343 =item I<$obj>-E<gt>B<delete> ()
352 my $entry = $obj->{'ldap'};
354 $entry->changetype ('delete');
356 $entry->update ($Ldap);
361 =item I<$obj>-E<gt>B<lastname> ([I<$lastname>])
363 Get or set the lastname.
370 my $entry = $obj->{'ldap'};
371 my $sn = $obj->{'sn'};
372 my $gn = $obj->{'givenName'};
374 my $dn = "cn=$cn," . $Config{'base_dn'};
378 print STDERR "This is _update_dn, trying to set dn=$dn";
380 $entry->changetype ('modify');
381 $entry->replace (sn => $sn, givenName => $gn, cn => $cn);
382 $entry->update ($Ldap);
384 $entry->update ($Ldap);
393 $obj->{'sn'} = shift;
397 return ($obj->{'sn'});
400 =item I<$obj>-E<gt>B<firstname> ([I<$firstname>])
402 Get or set the firstname.
412 $obj->{'givenName'} = shift;
416 return ($obj->{'givenName'});
419 =item I<$obj>-E<gt>B<name> ()
428 return ($obj->{'cn'});
431 =item I<$obj>-E<gt>B<address> ([I<@address>])
433 =item I<$obj>-E<gt>B<homephone> ([I<@homephone>])
435 =item I<$obj>-E<gt>B<cellphone> ([I<@cellphone>])
437 =item I<$obj>-E<gt>B<officephone> ([I<@officephone>])
439 =item I<$obj>-E<gt>B<fax> ([I<@fax>])
441 =item I<$obj>-E<gt>B<mail> ([I<@mail>])
443 =item I<$obj>-E<gt>B<uri> ([I<@uri>])
445 =item I<$obj>-E<gt>B<group> ([I<@groups>])
447 Get or set the attribute. This is the same as calling S<I<$obj>-E<gt>B<set>
448 (I<$field>, I<\@values>)> or S<I<$obj>-E<gt>B<get> (I<$field>)>.
456 my $field = $Person::AUTOLOAD;
458 return (undef) unless ($field);
462 return (set ($obj, $field, @values ? [@values] : undef))
465 =item I<$obj>-E<gt>B<get> (I<$field>)
467 Returs the value(s) of field I<$field>.
478 return (set ($obj, $field, undef));
482 return (scalar (set ($obj, $field, undef)));
486 =item I<$obj>-E<gt>B<set> (I<$field>, I<\@values>)
488 Sets the field I<$field> to the value(s) I<\@valued>. Pass an empty array-ref
497 my $value = @_ ? shift : undef;
498 my $entry = $obj->{'ldap'};
500 if (defined ($ExternalNames{$field}))
502 $field = $ExternalNames{$field};
504 if (!defined ($ValidFields{$field}))
509 if (defined ($value))
511 $entry->changetype ('modify');
513 if ($ValidFields{$field})
515 $entry->replace ($field, [@$value]);
516 $obj->{$field} = $value;
520 splice (@$value, 1) if (scalar (@$value) > 1);
521 $entry->replace ($field, $value);
522 $obj->{$field} = $value->[0];
525 $entry->update ($Ldap);
528 $obj->{$field} = [] unless (defined ($obj->{$field}));
530 if (wantarray () and $ValidFields{$field})
532 return (@{$obj->{$field}});
536 return ($obj->{$field});
544 my ($search) = $dn =~ m/cn\s*=\s*([^,]+)/i;
546 die unless ($search);
551 my $mesg = $Ldap->search
553 base => $Config{'base_dn'},
554 filter => "(cn=$search)"
557 if ($mesg->is_error ())
559 warn ("Error while querying LDAP server: " . $mesg->error_text ());
563 for ($mesg->entries ())
566 my ($t_cn) = $e->get_value ('cn', asref => 0);
567 my ($t_id) = $e->get_value ('uid', asref => 0);
583 Florian octo Forster E<lt>octo at verplant.orgE<gt>