Merge branch 'encode' into future
authorFlorian Forster <octo@verplant.org>
Mon, 11 Sep 2006 21:58:42 +0000 (23:58 +0200)
committerFlorian Forster <octo@verplant.org>
Mon, 11 Sep 2006 21:58:42 +0000 (23:58 +0200)
1  2 
licom.cgi

diff --combined licom.cgi
+++ b/licom.cgi
@@@ -20,6 -20,7 +20,7 @@@ use strict
  use warnings;
  use lib (qw(lib));
  
+ use Encode (qw(encode decode is_utf8));
  use CGI (':cgi');
  use CGI::Carp (qw(fatalsToBrowser));
  use URI::Escape;
@@@ -48,7 -49,7 +49,7 @@@ our %FieldNames 
  
  our $MySelf = $ENV{'SCRIPT_NAME'};
  
- our $Action = param ('action');
+ our $Action = param_utf8 ('action');
  $Action ||= 'default';
  
  our %Actions =
        save_group => [\&html_start, \&action_save_group, \&html_end]
  );
  
 -read_config ();
 +{
 +      my @files = (qw(/etc/licom/licom.conf));
 +      push (@files, './licom.conf') if (-r './licom.conf');
 +      read_config (@files);
 +}
  
  # make sure AuthLDAPRemoteUserIsDN is enabled.
  die unless ($ENV{'REMOTE_USER'});
  #set_config ('base_dn', $ENV{'REMOTE_USER'});
  
- die unless (defined (get_config ('uri'))
+ die ("Configuration is incomplete") unless (defined (get_config ('uri'))
        and defined (get_config ('base_dn'))
        and defined (get_config ('bind_dn'))
        and defined (get_config ('password')));
@@@ -88,7 -85,7 +89,7 @@@ LiCoM::Connection->connec
        uri      => get_config ('uri'),
        bind_dn  => get_config ('bind_dn'),
        password => get_config ('password')
- ) or die ("LiCoM::Connection->connect failed.");
+ ) or die ("Unable to connect to LDAP directory server " . get_config ('uri'));
  
  our ($UserCN, $UserID) = LiCoM::Person->get_user ($ENV{'REMOTE_USER'});
  
@@@ -99,7 -96,7 +100,7 @@@ if (!$UserID and $Action ne 'save'
  
  if (!$UserCN)
  {
 -      die ("No such user in the LDAP directory: " . $ENV{'REMOTE_USER'});
 +      die ("UserCN is not set. Make sure `AuthLDAPRemoteUserIsDN' in enabled.");
  }
  
  if (!defined ($Actions{$Action}))
@@@ -127,7 -124,7 +128,7 @@@ exit (0)
  
  sub action_browse
  {
-       my $group = param ('group');
+       my $group = param_utf8 ('group');
        $group = shift if (@_);
        $group ||= '';
  
                        my @members = $group->get_members ();
                        my $members = scalar (@members);
                        my $group_name = $group->name ();
-                       my $group_uri  = uri_escape ($group_name);
+                       my $group_uri  = uri_escape_utf8 ($group_name);
                        my $desc = $group->description ();
  
                        print qq#\t\t\t<li><a href="$MySelf?action=browse&group=$group_uri">#,
@@@ -166,7 -163,7 +167,7 @@@ EO
        else
        {
                my $group_obj    = LiCoM::Group->load ($group);
-               my $group_uri    = uri_escape ($group_obj->name ());
+               my $group_uri    = uri_escape_utf8 ($group_obj->name ());
                my $group_html   = encode_entities ($group_obj->name ());
                my @member_names = $group_obj->get_members ();
                my $desc         = $group_obj->description ();
                for (sort (@member_names))
                {
                        my $cn = $_;
-                       my $cn_uri  = uri_escape ($cn);
+                       my $cn_uri  = uri_escape_utf8 ($cn);
                        my $cn_html = encode_entities ($cn);
  
                        print qq(\t\t\t<li><a href="$MySelf?action=detail&cn=$cn_uri">$cn_html</a></li>\n);
@@@ -197,7 -194,7 +198,7 @@@ EO
  
  sub action_list
  {
-       my $group_name = param ('group');
+       my $group_name = param_utf8 ('group');
        $group_name = shift if (@_);
        $group_name ||= '';
  
@@@ -259,7 -256,7 +260,7 @@@ EO
                my $sn = $person->lastname ();
                my $gn = $person->firstname ();
  
-               my $cn_uri  = uri_escape ($cn);
+               my $cn_uri  = uri_escape_utf8 ($cn);
                my $cn_html = encode_entities ("$sn, $gn");
  
                print "\t\t\t<tr>\n",
  
        if ($group_name)
        {
-               my $group_esc = uri_escape ($group_name);
+               my $group_esc = uri_escape_utf8 ($group_name);
                print qq(\t\t<div class="menu">[<a href="$MySelf?action=browse&group=$group_esc">Back</a>]</div>\n);
        }
        else
  
  sub action_detail
  {
-       my $cn = param ('cn');
+       my $cn = param_utf8 ('cn');
        $cn = shift if (@_);
        die unless ($cn);
  
        my $cn_html = encode_entities ($cn);
-       my $cn_uri  = uri_escape ($cn);
+       my $cn_uri  = uri_escape_utf8 ($cn);
  
        my $person = LiCoM::Person->load ($cn);
        if (!$person)
@@@ -353,7 -350,7 +354,7 @@@ EO
                {
                        my $group = $groups[$i];
                        my $group_name = $group->name ();
-                       my $group_uri  = uri_escape ($group_name);
+                       my $group_uri  = uri_escape_utf8 ($group_name);
                        my $group_html = encode_entities ($group_name);
  
                        print "\t\t\t<tr>\n" if ($i != 0);
@@@ -377,7 -374,7 +378,7 @@@ EO
  
  sub action_search
  {
-       my $search = param ('search');
+       my $search = param_utf8 ('search');
  
        $search ||= '';
        $search =~ s/[^\s\w]//g;
        {
                my $person = $_;
                my $cn = $person->name ();
-               my $cn_uri  = uri_escape ($cn);
+               my $cn_uri  = uri_escape_utf8 ($cn);
                my $cn_html = encode_entities ($cn);
  
                print qq(\t\t<li><a href="$MySelf?action=detail&cn=$cn_uri">$cn_html</a></li>\n);
@@@ -431,7 -428,7 +432,7 @@@ sub action_edi
  {
        my %opts = @_;
  
-       my $cn = param ('cn');
+       my $cn = param_utf8 ('cn');
  
        $cn = $opts{'cn'} if (defined ($opts{'cn'}));
        $cn ||= '';
        my $lastname;
        my $firstname;
  
+       my $lastname_html;
+       my $firstname_html;
        my $contacts = {};
        $contacts->{$_} = [] for (@MultiFields);
  
                }
        }
  
-       $lastname    = param ('lastname')    if (param ('lastname')  and $UserID);
-       $firstname   = param ('firstname')   if (param ('firstname') and $UserID);
+       $lastname  = param_utf8 ('lastname')  if (param_utf8 ('lastname')  and $UserID);
+       $firstname = param_utf8 ('firstname') if (param_utf8 ('firstname') and $UserID);
  
        get_contacts ($contacts);
        
        $lastname    =   $opts{'lastname'}     if (defined ($opts{'lastname'}));
        $firstname   =   $opts{'firstname'}    if (defined ($opts{'firstname'}));
+       $lastname_html  = encode_entities ($lastname);
+       $firstname_html = encode_entities ($firstname);
        for (@MultiFields)
        {
                my $field = $_;
        }
  
        print <<EOF;
-               <form action="$MySelf" method="post">
+               <form action="$MySelf" method="post" accept-charset="UTF-8">
                <input type="hidden" name="action" value="save" />
                <input type="hidden" name="cn" value="$cn_html" />
                <table class="edit">
  EOF
        if ($UserID)
        {
-               print qq(\t\t\t\t<td><input type="text" name="lastname" value="$lastname" /></td>\n);
+               print qq(\t\t\t\t<td><input type="text" name="lastname" value="$lastname_html" /></td>\n);
        }
        else
        {
-               print qq(\t\t\t\t<td>$lastname</td>\n);
+               print qq(\t\t\t\t<td>$lastname_html</td>\n);
        }
        print <<EOF;
                        </tr>
  EOF
        if ($UserID)
        {
-               print qq(\t\t\t\t<td><input type="text" name="firstname" value="$firstname" /></td>\n);
+               print qq(\t\t\t\t<td><input type="text" name="firstname" value="$firstname_html" /></td>\n);
        }
        else
        {
-               print qq(\t\t\t\t<td>$firstname</td>\n);
+               print qq(\t\t\t\t<td>$firstname_html</td>\n);
        }
        
        print "\t\t\t</tr>\n";
@@@ -605,7 -608,7 +612,7 @@@ EO
  
  sub action_save
  {
-       my $cn = $UserID ? param ('cn') : $UserCN;
+       my $cn = $UserID ? param_utf8 ('cn') : $UserCN;
  
        if (verify_fields ())
        {
  
        die unless ($UserID);
  
-       my $button = lc (param ('button'));
+       my $button = lc (param_utf8 ('button'));
        $button ||= 'save';
  
        if ($button eq 'cancel')
                return;
        }
  
-       if (!param ('lastname') or !param ('firstname'))
+       if (!param_utf8 ('lastname') or !param_utf8 ('firstname'))
        {
                print qq(\t<div class="error">You have to give both, first and lastname, to identify this record.</div>\n);
                action_edit (cn => '');
                return;
        }
  
-       my $lastname  = param ('lastname');
-       my $firstname = param ('firstname');
+       my $lastname  = param_utf8 ('lastname');
+       my $firstname = param_utf8 ('firstname');
  
        my $contacts = get_contacts ();
  
        
        $cn = $person->name ();
  
-       for (param ('group'))
+       for (param_utf8 ('group'))
        {
                my $group_name = $_;
                my $group = LiCoM::Group->load ($group_name);
                }
        }
  
-       if (param ('newgroup'))
+       if (param_utf8 ('newgroup'))
        {
                # FIXME add error handling
-               my $group_name = param ('newgroup');
+               my $group_name = param_utf8 ('newgroup');
                LiCoM::Group->create ($group_name, '', $cn);
        }
  
  
  sub action_update
  {
-       my $cn = $UserID ? param ('cn') : $UserCN;
-       my $person = LiCoM::Person->load ($cn);
+       my $cn = $UserID ? param_utf8 ('cn') : $UserCN;
  
-       die unless ($person);
+       my $person = LiCoM::Person->load ($cn);
+       die ("Unable to load CN `$cn'") unless ($person);
  
-       my $button = lc (param ('button'));
+       my $button = lc (param_utf8 ('button'));
        $button ||= 'save';
  
        if ($UserID and $button eq 'cancel')
  
        if ($UserID)
        {
-               my $lastname  = param ('lastname');
-               my $firstname = param ('firstname');
+               my $lastname  = param_utf8 ('lastname');
+               my $firstname = param_utf8 ('firstname');
+               my $old_cn = $person->name ();
+               print <<HTML;
+ <div><code>
+       \$lastname = $lastname<br />
+       \$firstname = $firstname<br />
+       \$old_cn = $old_cn
+ </code></div>
+ HTML
  
                $person->lastname  ($lastname)  if ($lastname  and $lastname  ne $person->lastname ());
                $person->firstname ($firstname) if ($firstname and $firstname ne $person->firstname ());
  
                $cn = $person->name ();
-               # FIXME Fix groups:
-               # Each group is one entry of type (objectClass=groupOfNames)
-               # with one or more `member' attributes. These attributes are
-               # the `dn' (distinguished name) of the member entries.
+               # Change the cn's saved in the groups
+               if ($old_cn ne $cn)
+               {
+                       my @groups = LiCoM::Group->load_by_member ($old_cn);
+                       for (@groups)
+                       {
+                               # ->del_members automatically deleted the
+                               # group, if no more members exist. So this
+                               # order is important.
+                               print "<div><code>\$cn = " . encode_entities ($cn) . "; "
+                               . "\$old_cn = " . encode_entities ($old_cn) . ";</code></div>\n";
+                               $_->add_members ($cn);
+                               $_->del_members ($old_cn);
+                       }
+               } # if ($old_cn ne $cn)
        }
  
        my $contacts = get_contacts ();
        # only `authorized' users may see and change groups
        if ($UserID)
        {
-               my %changed_groups = map { $_ => 1 } (param ('group'));
+               my %changed_groups = map { $_ => 1 } (param_utf8 ('group'));
                my @current_groups = LiCoM::Group->load_by_member ($cn);
  
                for (@current_groups)
                        $group_obj->add_members ($cn);
                }
  
-               if (param ('newgroup'))
+               if (param_utf8 ('newgroup'))
                {
                        # FIXME add error handling
-                       my $group_name = param ('newgroup');
+                       my $group_name = param_utf8 ('newgroup');
                        LiCoM::Group->create ($group_name, '', $cn);
                }
        }
@@@ -792,7 -817,7 +821,7 @@@ HTM
  
  sub action_vcard
  {
-       my $cn = param ('cn');
+       my $cn = param_utf8 ('cn');
        $cn = shift if (@_);
        die unless ($cn);
  
  
        my $sn = $person->lastname ();
        my $gn = $person->firstname ();
-       my $cn_esc = uri_escape ($cn);
+       my $cn_esc = uri_escape_utf8 ($cn);
  
        print <<EOF;
  Content-Type: text/x-vcard
@@@ -843,7 -868,7 +872,7 @@@ EO
  
  sub action_verify
  {
-       my $cn = param ('cn');
+       my $cn = param_utf8 ('cn');
        $cn = shift if (@_);
        die unless ($cn);
  
@@@ -895,7 -920,7 +924,7 @@@ sub action_verify_send_mai
        my ($owner_mail) = $owner->get ('mail');
        if (!$owner_mail)
        {
-               my $cn_uri = uri_escape ($UserCN);
+               my $cn_uri = uri_escape_utf8 ($UserCN);
                print qq(\t\t<div class="error">You have no email set in your own profile. <a href="$MySelf?action=edit&cn=$cn_uri">Edit it now</a>!</div>\n);
                return (0);
        }
@@@ -958,13 -983,13 +987,13 @@@ EO
  
  sub action_ask_del
  {
-       my $cn = param ('cn');
+       my $cn = param_utf8 ('cn');
        $cn or die;
  
        my $person = LiCoM::Person->load ($cn);
        $person or die;
  
-       my $cn_uri  = uri_escape ($cn);
+       my $cn_uri  = uri_escape_utf8 ($cn);
        my $cn_html = encode_entities ($cn);
  
        print <<EOF;
@@@ -985,7 -1010,7 +1014,7 @@@ EO
  
  sub action_do_del
  {
-       my $cn = param ('cn');
+       my $cn = param_utf8 ('cn');
        $cn or die;
  
        my $cn_html = encode_entities ($cn);
@@@ -1004,7 -1029,7 +1033,7 @@@ EO
  
  sub action_edit_group
  {
-       my $group_name = param ('group') or die;
+       my $group_name = param_utf8 ('group') or die;
  
        my $group_name_html = encode_entities ($group_name);
  
  
        print <<HTML;
        <h2>Edit contact group &quot;$group_name_html&quot;</h2>
-       <form action="$MySelf" method="post">
+       <form action="$MySelf" method="post" accept-charset="UTF-8">
          <input type="hidden" name="action" value="save_group" />
          <input type="hidden" name="group" value="$group_name_html" />
          <table>
@@@ -1044,7 -1069,7 +1073,7 @@@ HTM
  
  sub action_save_group
  {
-       my $group_name = param ('group') or die;
+       my $group_name = param_utf8 ('group') or die;
  
        my $group_name_html = encode_entities ($group_name);
  
                return;
        }
  
-       my $desc = param ('description');
+       my $desc = param_utf8 ('description');
        $group_obj->description ($desc);
  
        action_browse ();
  
        if ($UserID)
        {
-               my $search = param ('search') || '';
+               my $search = param_utf8 ('search') || '';
                $search = encode_entities ($search);
                print <<EOF;
                <div class="topmenu">
-                       <form action="$MySelf" method="post">
+                       <form action="$MySelf" method="post" accept-charset="UTF-8">
                                <input type="hidden" name="action" value="browse" />
                                <input type="submit" name="button" value="Browse" />
                        </form>
-                       <form action="$MySelf" method="post">
+                       <form action="$MySelf" method="post" accept-charset="UTF-8">
                                <input type="hidden" name="action" value="search" />
                                <input type="text" name="search" value="$search" />
                                <input type="submit" name="button" value="Search" />
                        </form>
-                       <form action="$MySelf" method="post">
+                       <form action="$MySelf" method="post" accept-charset="UTF-8">
                                <input type="hidden" name="action" value="edit" />
                                <input type="hidden" name="dn" value="" />
                                <input type="submit" name="button" value="Add New" />
@@@ -1370,7 -1395,7 +1399,7 @@@ sub pwge
  sub verify_fields
  {
        my @errors = ();
-       for (param ('uri'))
+       for (param_utf8 ('uri'))
        {
                my $val = $_;
                next unless ($val);
                }
        }
  
-       for (param ('homephone'), param ('cellphone'), param ('officephone'), param ('fax'))
+       for (param_utf8 ('homephone'), param_utf8 ('cellphone'), param_utf8 ('officephone'), param_utf8 ('fax'))
        {
                my $number = $_;
                next unless ($number);
@@@ -1412,7 -1437,7 +1441,7 @@@ sub markup_fiel
        my $field = shift;
        my $value = shift;
  
-       my $value_uri  = uri_escape ($value);
+       my $value_uri  = uri_escape_utf8 ($value);
        my $value_html = encode_entities ($value);
  
        if ($field eq 'group')
        {
                if ($value =~ m#^([a-z]+)://(.+)$#)
                {
-                       $value_uri = $1 . '://' . uri_escape ($2);
+                       $value_uri = $1 . '://' . uri_escape_utf8 ($2);
                }
                else
                {
-                       $value_uri = 'http://' . uri_escape ($value);
+                       $value_uri = 'http://' . uri_escape_utf8 ($value);
                }
                return (qq(<a href="$value_uri" class="extern">$value_html</a>));
        }
@@@ -1445,7 -1470,7 +1474,7 @@@ sub get_contact
        for (@MultiFields)
        {
                my $field = $_;
-               my @values = grep { $_ } (param ($field));
+               my @values = grep { $_ } (param_utf8 ($field));
  
                next unless (@values);
  
  
        return ($contacts);
  }
+ sub is_valid_utf8
+ {
+       my $str = join ('', @_);
+       # Taken from here: <http://www.w3.org/International/questions/qa-forms-utf-8>
+       return ($str =~ m/^(
+      [\x09\x0A\x0D\x20-\x7E]            # ASCII
+    | [\xC2-\xDF][\x80-\xBF]             # non-overlong 2-byte
+    |  \xE0[\xA0-\xBF][\x80-\xBF]        # excluding overlongs
+    | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2}  # straight 3-byte
+    |  \xED[\x80-\x9F][\x80-\xBF]        # excluding surrogates
+    |  \xF0[\x90-\xBF][\x80-\xBF]{2}     # planes 1-3
+    | [\xF1-\xF3][\x80-\xBF]{3}          # planes 4-15
+    |  \xF4[\x80-\x8F][\x80-\xBF]{2}     # plane 16
+   )*$/x);
+ }
+ sub param_utf8
+ {
+       my @args = @_;
+       my @ret = ();
+       @ret = grep { is_valid_utf8 ($_) } (param (@args));
+       $_ = decode ('UTF-8', $_) for (@ret);
+       return (wantarray () ? @ret : $ret[0]);
+ }
+ sub uri_escape_utf8
+ {
+       return (uri_escape (encode ('UTF-8', shift)));
+ }