add support for some new fields and some output cleanups.
[mirror/userdir-ldap-cgi.git] / search.cgi
1 #!/usr/bin/perl
2
3 # $Id: search.cgi,v 1.14 2006/12/22 08:58:50 rmurray Exp $
4 # (c) 1999 Randolph Chung. Licensed under the GPL. <tausq@debian.org>
5 # (c) 2004 Martin Schulze. Licensed under the GPL. <joey@debian.org>
6 # (c) 2006 Ryan Murray. Licensed under the GPL. <rmurray@debian.org>
7
8 use lib '.';
9 use strict vars;
10 #use Apache::Registry;
11 use CGI;
12 use Util;
13 use URI::Escape;
14 use Net::LDAP qw(:all);
15
16 # Global settings...
17 my %config = &Util::ReadConfigFile;
18
19 my $query = new CGI;
20 my $id = $query->param('id');
21 my $authtoken = $query->param('authtoken');
22 my $password = &Util::CheckAuthToken($authtoken);
23 my $dosearch = $query->param('dosearch');
24 my $searchdn = $query->param('searchdn');
25 my $ldap = undef;
26
27 my $proto = ($ENV{HTTPS} ? "https" : "http");
28
29 sub DieHandler {
30   $ldap->unbind if (defined($ldap));
31 }
32
33 $SIG{__DIE__} = \&DieHandler;
34
35 if (!$dosearch) {
36   # No action yet, send back the search form...
37   &Util::HTMLSendHeader;
38   open (F, "<$config{websearchhtml}") || &Util::HTMLError($!);
39   while (<F>) {
40     s/~id~/$id/g;
41     s/~authtoken~/$authtoken/g;    
42     print;
43   }
44   close F;
45 } else {
46   # Go ahead and construct the search terms
47   my %searchdata = (
48     cn             => { fuzzy => 'cnfuzzy', formname => 'cn' }, # First name
49     mn             => { fuzzy => 'mnfuzzy', formname => 'mn' }, # Middle name
50     sn             => { fuzzy => 'snfuzzy', formname => 'sn' }, # Last name
51     email          => { fuzzy => 'emailfuzzy', formname => 'email' }, # email
52     uid            => { fuzzy => 'uidfuzzy', formname => 'uid' }, # Login name
53     ircnick        => { fuzzy => 'ircfuzzy', formname => 'ircnick' }, # IRC nickname
54     keyfingerprint => { fuzzy => 'fpfuzzy', formname => 'fingerprint' }, # PGP/GPG fingerprint
55     c              => { formname => 'country'}, # Country
56   );
57
58   # Do a little preprocessing - strip the spaces out of the fingerprint
59   my $temp = $query->param('fingerprint');
60   $temp =~ s/ //g; $query->param('fingerprint', $temp);
61
62   # go through %searchdata and pull out all the search criteria the user
63   # specified...
64   my $filter = "(objectclass=inetOrgPerson)";
65   foreach (keys(%searchdata)) {
66     if ($query->param($searchdata{$_}{formname})) {    
67       if ($query->param($searchdata{$_}{fuzzy})) {
68         # fuzzy search
69         $filter .= "($_~=".$query->param($searchdata{$_}{formname}).")";
70       } else {
71         $filter .= "($_=".$query->param($searchdata{$_}{formname}).")";
72       }
73     }
74   }
75   
76   # Vacation is a special case, support it only when user is authenticated
77   $filter .= "(onvacation=*)" if ($query->param('vacation') && $authtoken && $id);
78
79   # AND all the search terms together
80   $filter = "(&$filter)";
81   
82   # Read in the result template...
83   my ($lineref, $dataspecref) = ParseResult($config{websearchresulthtml});
84
85   # Now, we are ready to connect to the LDAP server.
86   $ldap = Net::LDAP->new($config{ldaphost}) || &Util::HTMLError($!);
87   my $auth = 0;
88   my $mesg;
89
90   if ($id && $password) {
91     $mesg = $ldap->bind("uid=$id,$config{basedn}", password => $password);
92     $mesg->sync;
93     $auth = ($mesg->code == LDAP_SUCCESS);
94   }
95
96   if (!$auth) { # Not authenticated - either the above failed, or no password supplied
97     $ldap->bind;
98   }
99
100 #  &Util::HTMLPrint("Searching in $config{basedn} for $filter...\n");
101   
102   $mesg = $ldap->search(base   => ($searchdn ? $searchdn : $config{basedn}),
103                         filter => ($searchdn ? "(uid=*)" : $filter));
104   $mesg->code && &Util::HTMLError($mesg->error);
105
106   my %outsub; # this hash will contain all the substitution tokens in the output
107   $outsub{count} = $mesg->count; # Count number of requests, also ensures we're done with the search
108   $outsub{auth} = $authtoken;
109   $outsub{authtoken} = $authtoken; # alias
110   $outsub{id} = $id;
111   $outsub{searchresults} = undef;
112   
113   my $entries = $mesg->as_struct; # entries contain a hashref to all the search results
114   my ($dn, $attr, $data); 
115
116   # Format the output....
117   foreach $dn (sort {$entries->{$a}->{sn}->[0] <=> $entries->{$b}->{sn}->[0]} keys(%$entries)) {
118     my $ok = 0;
119     $data = $entries->{$dn};
120
121     # These are local variables.. i have enough global vars as it is... <sigh>
122     my ($ufdn, $login, $name, $icquin, $jabberjid, $email, $fingerprint,
123         $address, $latlong, $vacation, $created, $modified, $lastseen, $gender) = undef;
124     
125     $ufdn = $dn; # Net::LDAP does not have a dn2ufn function, but this is close enough :)
126     
127     # Assemble name, attach web page link if present.
128     $name = $data->{cn}->[0]." ".$data->{mn}->[0]." ".$data->{sn}->[0];
129     if (my $url = $data->{labeleduri}->[0]) {
130       $name = "<a href=\"$url\">$name</a>";
131     }
132     
133     # Add links to all email addresses
134     foreach (@{$data->{emailforward}}) {
135       $email .= "<br>" if ($email);
136       $email .= "<a href=\"mailto:$_\">$_</a>";
137     }
138
139     # ICQ 
140     if ($data->{icquin}->[0]) {
141       $icquin = sprintf("<a href=\"http://wwp.icq.com/%s\">%s</a>", $data->{icquin}->[0], $data->{icquin}->[0]);
142     }
143     
144     # Format PGP/GPG key fingerprints
145     my $fi;
146     foreach (@{$data->{keyfingerprint}}) {
147       $fingerprint .= "<br>" if ($fingerprint);
148       $fingerprint .= sprintf("%d:- <a href=\"fetchkey.cgi?fingerprint=%s\">%s</a>", ++$fi, $_, &Util::FormatFingerPrint($_));
149     }
150     
151     # Assemble addresses
152     $address = $data->{postaladdress}->[0] || "- unlisted -";
153     $address =~ s/\$/<br>/g;
154     $address .= "<br>".$data->{l}->[0]."<br>".&Util::LookupCountry($data->{c}->[0])."<br>".$data->{postalcode}->[0];
155
156     # Assemble latitude/longitude
157     $latlong  = $data->{latitude}->[0] || "none";
158     $latlong .= " / ";
159     $latlong .= $data->{longitude}->[0] || "none";    
160
161     # Gender
162     if ($data->{gender}->[0]) {
163         if ($data->{gender}->[0] == 1) {
164             $gender = $dataspecref->{male};
165         } elsif ($data->{gender}->[0] == 2) {
166             $gender = $dataspecref->{female};
167         } else {
168             $gender = $dataspecref->{unspecified};
169         }
170     } else {
171         $gender = $dataspecref->{unspecified};
172     }
173
174     # Modified/created time. TODO: maybe add is the name of the creator/modifier
175     $modified = &Util::FormatTimestamp($data->{modifytimestamp}->[0]);
176     $created =  &Util::FormatTimestamp($data->{createtimestamp}->[0]);
177
178     # Last seen information (Echelon)
179     $lastseen = &Util::FormatLastSeen($data->{"activity-pgp"}->[0],
180                                       $data->{"activity-from"}->[0]);
181
182     # Link in the debian login id 
183     $login = $data->{uid}->[0];
184     $login = "$login";
185     
186     # See if the user has a vacation message, non-public
187     $vacation = $data->{onvacation}->[0] if ($authtoken && $id);
188
189     # OK, now generate output... (i.e. put the output into the buffer )
190     $outsub{searchresults} .= '<table border=2 cellpadding=2 cellspacing=0 bgcolor="#DDDDDD" width="80%">';
191     $outsub{searchresults} .= '<tr><th bgcolor="#44CCCC" colspan=2><font size=+1>'."$name</font> ";
192     $outsub{searchresults} .= "($ufdn)</th></tr>\n";
193     
194     if ($vacation) {
195       $outsub{searchresults} .= "<tr><td colspan=2 align=center><b>$vacation</b></td></tr>\n";
196     }
197
198     $outsub{searchresults} .= FormatEntry($dataspecref->{uid}, $login);
199     $outsub{searchresults} .= FormatEntry($dataspecref->{gender}, $gender);
200     if ($data->{ircnick}->[0]) {
201       $outsub{searchresults} .= FormatEntry($dataspecref->{ircnick}, $data->{ircnick}->[0]);
202     }
203     if ($data->{jabberjid}->[0]) {
204       $outsub{searchresults} .= FormatEntry($dataspecref->{jabberjid}, $data->{jabberjid}->[0]);
205     }
206     if ($icquin) {
207       $outsub{searchresults} .= FormatEntry($dataspecref->{icquin}, $icquin);
208     }
209     $outsub{searchresults} .= FormatEntry($dataspecref->{loginshell}, $data->{loginshell}->[0]);
210     $outsub{searchresults} .= FormatEntry($dataspecref->{fingerprint}, $fingerprint);
211     if ($data->{maildisablemessage}->[0]) {
212       $outsub{searchresults} .= FormatEntry($dataspecref->{maildisablemessage}, $data->{maildisablemessage}->[0]);
213     }
214
215     if ($auth) {
216       # Some data should only be available to authorized users...
217       if ($id eq $data->{uid}->[0]) {
218         $outsub{searchresults} .= FormatEntry($dataspecref->{email}, $email);
219       }
220       $outsub{searchresults} .= FormatEntry($dataspecref->{birthdate}, $data->{birthdate}->[0]);
221       $outsub{searchresults} .= FormatEntry($dataspecref->{address}, $address);
222       $outsub{searchresults} .= FormatEntry($dataspecref->{latlong}, $latlong);
223       $outsub{searchresults} .= FormatEntry($dataspecref->{phone}, $data->{telephonenumber}->[0] || "- unlisted -");
224       $outsub{searchresults} .= FormatEntry($dataspecref->{fax}, $data->{fascimiletelephonenumber}->[0] || "- unlisted -");
225       $outsub{searchresults} .= FormatEntry($dataspecref->{lastseen}, $lastseen);
226 #     $outsub{searchresults} .= FormatEntry($dataspecref->{created}, $created);
227 #     $outsub{searchresults} .= FormatEntry($dataspecref->{modified}, $modified);
228     }
229     
230     $outsub{searchresults} .= "</table>";
231     
232     # If this is ourselves, present a link to do mods
233     if ($auth && ($id eq $data->{uid}->[0])) { #TODO: extract this string into a url for translation...
234       $outsub{searchresults} .= "<a href=\"$proto://$ENV{SERVER_NAME}/$config{webupdateurl}?id=$id&authtoken=$authtoken&editdn=".uri_escape($dn, "\x00-\x40\x7f-\xff")."\">Edit my settings</a>\n";
235     }
236     
237     $outsub{searchresults} .= "<br><br><br>\n";
238   }
239   
240   # Finally, we can write the output... yuck...
241   &Util::HTMLSendHeader;
242   foreach (@$lineref) {
243     if (/<\?ifauth(.+?)\?>/) {
244       $_ = ($auth ? $1 : "");
245     } elsif (/<\?ifnoauth(.+?)\?>/) {
246       $_ = ($auth ? "" : $1);
247     }
248     s/~(.+?)~/$outsub{$1}/g;
249     print;
250   }
251
252   $ldap->unbind;
253 }
254
255 sub ParseResult {
256   # Reads the output html file and find out how the output should be named
257   # -- this gives us a way to do translations more easily
258   # Returns the contents of the template (w/o the searchresult portion) and
259   # the output specification
260   my $fn = shift;
261   my $insec = 0;
262   my @lines;
263   my %hash;
264   
265   open (F, "<$fn") || &Util::HTMLError("$fn: $!");
266   while (<F>) {
267     if (!$insec) {
268       if (/<\?searchresults/i) {
269         $insec = 1;
270         push(@lines, "~searchresults~\n"); # Leave token so we know where to put the result
271       } else {
272         push(@lines, $_);
273       }
274     } else {
275       if (/searchresults\?>/i) {
276         $insec = 0;
277       } else {
278         if (!/^\s*#/) {
279           s/^ *\(//; 
280           s/\) *$//; # remove leading/trailing () and spaces
281           chomp;
282           my ($desc, $attr) = split(/, /, $_, 2);
283           $hash{$attr} = $desc;
284         }
285       }
286     }
287   }
288   close F;
289   return (\@lines, \%hash);
290 }
291
292 sub FormatEntry {
293   my ($key, $val) = @_;
294   
295   return "<tr><td align=right><b>$key:</b></td><td>&nbsp;$val</td></tr>\n";
296 }
297
298 exit 0;