* * Copyright (c) 1999-2002 The SquirrelMail Project Team * and Alexandros Vellis * * Licensed under the GNU GPL. For full terms see the file COPYING that came * with the Squirrelmail distribution. * * Also view plugins/README.plugins for more information. * * $Id: functions.php,v 1.1.1.1 2004/01/02 16:07:15 avel Exp $ * * @package plugins * @subpackage ldapuserdata */ /** * This file contains the main plugin functions that connect to, read from and * write to LDAP. */ require (SM_PATH . "plugins/ldapuserdata/config.php"); /** * Convenience function for connecting to LDAP. * * This is my convenience function for connecting to the LDAP database. * * @param str $bind Who to connect as to LDAP. One of squirrel, or manager, or * anonymous, or uid to search for. Note: 'user' is currently broken. * @param bool $master If I need to connect to Master LDAP database for writes. * @return object LDAP handle. * @todo Fix 'bind as user'; An ldap search on the user DN must first be done. */ function ldapuserdata_ldap_connect ($bind = 'squirrel', $master = false) { global $ldap_host, $ldap_master_host, $username, $ldap_base_dn, $ldap_network_timeout; if($master) { $ldap_host = $ldap_master_host; } $ldap_error = 0; if (!($ldap = ldap_connect($ldap_host))) { $errormsg = "Could not connect to LDAP!"; exit; } if (!ldap_set_option($ldap, LDAP_OPT_PROTOCOL_VERSION, 3)) { $errormsg = "Failed to set protocol version to 3"; exit; } /* if (!$master) { if (!ldap_set_option($ldap, LDAP_OPT_NETWORK_TIMEOUT, $ldap_network_timeout)) { $errormsg = "Failed to set network timeout.\n"; } }*/ switch ($bind) { /* Broken - TODO. This will be the 'default' in the future. */ case 'user': global $login_password; /* FIXME, what's the name again? */ if (!($search_result = ldap_search($ldap, $ldap_base_dn, "UID=$uid", array('uid')))) { $errormsg = 'Could not do anonymous search in LDAP Directory.
'. 'So, binding as user cannot be done here.
'. 'Please contact your administrator.'; } $entries = ldap_get_entries($ldap, $search_result); if (!is_array($entries[0])) { $errormsg = "Error while searching for $uid:
" . "The username and/or password you have provided is incorrect."; session_destroy(); exit; } $binddn = $entries[0]['dn']; $bind_result = ldap_bind( $ldap, $binddn, $login_password); break; case 'manager': global $ldap_manager_dn, $ldap_manager_pw; $bind_result = ldap_bind( $ldap, $ldap_manager_dn, $ldap_manager_pw); break; case 'squirrel': default: global $ldap_bind_dn, $ldap_bind_pw; $bind_result = ldap_bind( $ldap, $ldap_bind_dn, $ldap_bind_pw); break; } if (!$bind_result) { $errormsg = "Error while binding to LDAP server as $bind.
" . "Please contact your administrator.
". "If you are the administrator, please check the " . "credentials provided in the ldapuserdata plugin configuration."; exit; } return $ldap; } /** * Read user data from LDAP database. * * Data will be written to the session, in $_SESSION['ldap_prefs_cache'], * together with some additional data (such as $_SESSION['prefs_before'] for * doing compares when writing back, $_SESSION['dn'] for the user's * distinguished name etc. * * @return void */ function ldapuserdata_read_do() { global $login_username, $imapServerAddress, $full_name, $email_address, $ldap_bind_dn, $ldap_host, $authz; /* --- $authz support --- */ /* --- fill $ldap_prefs_cache with data from LDAP. --- */ if(isset($authz) && strlen($authz) > 0 ) { $ret = ldapuserdata_retrieve_data($authz, $ldap_prefs_cache, $extra_data); } else { $ret = ldapuserdata_retrieve_data($login_username, $ldap_prefs_cache, $extra_data); } /* print "DEBUG: 
";
	print_r($ldap_prefs_cache);
	print_r($_SESSION);
	print_r ($_POST);
	print "
"; */ /* $prefs_before will remain, for checking if there are any changes to * write in the end. */ $prefs_before = $ldap_prefs_cache; /* Save sensitive information to session variables outside ldap prefs * cache, so that they cannot be tampered by the user. */ // print_r($extra_data); $full_name = $ldap_prefs_cache['full_name']; $email_address = $ldap_prefs_cache['email_address']; $imapServerAddress = $ldap_prefs_cache['imapServerAddress']; $vars = array('dn', 'identities', 'identities_map', 'alternatenames', 'alternateemails', 'authorizedreplyto'); foreach($vars as $var) { if(isset($extra_data[$var])) { $$var = $extra_data[$var]; sqsession_register($$var, $var); } } /* $dn = $extra_data['dn']; $identities = $extra_data['identities']; $identities_map = $extra_data['identities_map']; $alternatenames = $extra_data['alternatenames']; $alternateemails = $extra_data['alternatenames']; $authorizedreplyto = $extra_data['authorizedreplyto']; */ $prefs_are_cached = true; sqsession_register($prefs_are_cached, 'prefs_are_cached'); sqsession_register($ldap_prefs_cache, 'ldap_prefs_cache'); sqsession_register($prefs_before, 'prefs_before'); sqsession_register($imapServerAddress, 'imapServerAddress'); sqsession_register($full_name, 'full_name'); sqsession_register($email_address, 'email_address'); /* sqsession_register($dn, 'dn'); sqsession_register($identities, 'identities'); sqsession_register($identities_map, 'identities_map'); sqsession_register($alternatenames, 'alternatenames'); sqsession_register($alternateemails, 'alternateemails'); */ } /** * Retrieve user data from an LDAP database. * * This function logs on to the LDAP server, returns the user preferences of * the specified user and logs out. * * @param string $uid UserID of the authorized user for whom to get preferences * @param array &$user_prefs Reference to the array where preferences will be stored. * @param array &$extra_info Reference to the array where extra data will be stored. * @return boolean */ function ldapuserdata_retrieve_data ($uid, &$user_prefs, &$extra_info) { global $ldap_host, $ldap_base_dn, $ldap_bind_dn, $ldap_bind_pw, $ldap_manager_dn, $ldap_manager_pw, $required_objectclass, $ldap_objectclass, $prefs_default, $ldap_attributes, $boolean_attrs, $multivalue_attrs, $alternatemail_attrs, $languages, $default_charset; $ldap = ldapuserdata_ldap_connect('squirrel', false); // $ldap = ldapuserdata_ldap_connect($uid, false); // $ldapattrarray = array_values($ldap_attributes); // print "
"; print_r(array_keys($ldap_attributes)); print "
"; if (!($search_result = ldap_search($ldap, $ldap_base_dn, "UID=$uid", array_merge( array_keys($ldap_attributes), array_keys($multivalue_attrs), array_keys($alternatemail_attrs), array('objectclass') ) ))) { print "Error while searching for $uid."; exit; } $info = ldap_get_entries($ldap, $search_result); ldap_close($ldap); if (!isset($info[0])) { logout_error( _("Unknown user or password incorrect.") ); // error_username_password_incorrect(); /* $errormsg = "Error while searching for $uid:
" . "The username and/or password you have provided is incorrect."; */ session_destroy(); exit; } if(isset($required_objectclass)) { if(!in_array($required_objectclass, $info[0]['objectclass'])) { $errormsg = "User $uid does not have access to the mail service.
"; session_destroy(); exit; } } /* Check if we have objectClass $ldap_objectclass (default: SquirrelMailUser) */ if (in_array($ldap_objectclass, $info[0]['objectclass'])) { $already_member = true; } else { $already_member = false; } if(isset($info[0]['language'][0])) { $mycharset = $languages[$info[0]['language'][0]]['CHARSET']; } else { $mycharset = $default_charset; } /* Read in LDAP Preferences */ if ($info["count"] == 1) { reset($ldap_attributes); while(list($ldapattr, $squirrelattr) = each($ldap_attributes)) { if (isset($info[0][$ldapattr][0])) { $prefs[$squirrelattr] = mb_convert_encoding( $info[0][$ldapattr][0], $mycharset, "UTF-8"); //print "DBG: $ldapattr aka $squirrelattr " .$info[0][$ldapattr][0] ."
"; } } } else { print "Error, more than one $uid found."; exit; } foreach($languages as $lang => $attrs) { if (isset($info[0]['cn;lang-'.$lang]['count'])) { $extra['alternatenames'][] = mb_convert_encoding($info[0]['cn;lang-'.$lang][0], $mycharset, "UTF-8"); } } /* Special handling of some multivalue attributes: */ /* Special treatment for POP mail-fetch. */ if (isset($info[0]['mailfetch']['count'])) { $prefs['mailfetch'] = $info[0]['mailfetch']; } if(isset($info[0]['mailfetch']['count']) && $info[0]['mailfetch']['count'] > 0) { $prefs['mailfetch_server_number'] = $info[0]['mailfetch']['count']; for ($i=0; $i < $info[0]['mailfetch']['count']; $i++) { $fetcharray = unserialize ($prefs['mailfetch'][$i]); $prefs['mailfetch_server_'.$i] = $fetcharray[0]; $prefs['mailfetch_alias_'.$i] = $fetcharray[1]; $prefs['mailfetch_user_'.$i] = $fetcharray[2]; $prefs['mailfetch_pass_'.$i] = $fetcharray[3]; $prefs['mailfetch_cypher_'.$i] = $fetcharray[4]; $prefs['mailfetch_lmos_'.$i] = $fetcharray[5]; $prefs['mailfetch_login_'.$i] = $fetcharray[6]; $prefs['mailfetch_fref_'.$i] = $fetcharray[7]; $prefs['mailfetch_subfolder_'.$i] = $fetcharray[8]; $prefs['mailfetch_uidl_'.$i] = $fetcharray[9]; } } /* Special treatment for newmail plugin. */ if(isset($info[0]['newmail'][0])) { $prefs['newmail'] = $info[0]['newmail'][0]; $newarray = unserialize($prefs['newmail']); $prefs['newmail_enable'] = $newarray[0]; $prefs['newmail_popup'] = $newarray[1]; $prefs['newmail_allbox'] = $newarray[2]; $prefs['newmail_recent'] = $newarray[3]; $prefs['newmail_changetitle'] = $newarray[4]; $prefs['newmail_media'] = $newarray[5]; } /* Some additional thingies for the options: move_to_trash, * move_to_sent, save_as_draft, which are NOT included in the ldap * schema. */ if( (isset($prefs['trash_folder']) && $prefs['trash_folder'] != 'none') || !isset($prefs['trash_folder']) ) { $prefs['move_to_trash'] = 1; } else { $prefs['move_to_trash'] = 0; } if( (isset($prefs['sent_folder']) && $prefs['sent_folder'] != 'none') || !isset($prefs['sent_folder']) ) { $prefs['move_to_sent'] = 1; } else { $prefs['move_to_sent'] = 0; } if( (isset($prefs['draft_folder']) && $prefs['draft_folder'] != 'none') || !isset($prefs['draft_folder']) ) { $prefs['save_as_draft'] = 1; } else { $prefs['save_as_draft'] = 0; } /* Handle boolean attributes. Must change the upper case string TRUE | * FALSE to 1 or 0 so that Squirrelmail can handle it sanely. */ while(list($ldapattr, $squirrelattr) = each($boolean_attrs)) { if( array_key_exists($squirrelattr, $prefs) ) { if($prefs[$squirrelattr] == "TRUE") { $prefs[$squirrelattr] = 1; } elseif ($prefs[$squirrelattr] == "FALSE") { $prefs[$squirrelattr] = 0; } } } /* ------------- End of preferences ($prefs) ----------------- */ /* mail alternate address - identities */ if (isset($info[0]['mailalternateaddress']['count'])) { $identities = array(); $identities_map = array(); for($i = 0; $i < $info[0]['mailalternateaddress']['count']; $i++) { $extra['alternateemails'][$i] = $info[0]['mailalternateaddress'][$i]; $identities[$info[0]['mailalternateaddress'][$i]]['email_address'] = $info[0]['mailalternateaddress'][$i]; $identities_map[$i+1] = $info[0]['mailalternateaddress'][$i]; $m = $i+2; } } /* TODO */ // require_once(SM_PATH . 'class/mime/Rfc822Header.class.php'); // $rfc822_header = new Rfc822Header(); if (isset($info[0]['mailauthorizedaddress']['count'])) { for($i=0; $i<$info[0]['mailauthorizedaddress']['count'] ; $i++) { $ident = array(); /* Fill $identities array with data from mailauthorized * address */ /* My mailAuthorized address has a special format: * Comment */ //$ret = $rfc822_header->parseAddress($info[0]['mailauthorizedaddress'][$i], true ); //print "just called:"; //print "rfc822_header->parseAddress($info[0]['mailauthorizedaddress'][$i], true )"; //print_r($ret); if(strstr($info[0]['mailauthorizedaddress'][$i], "<")) { $rx = "/<.+>/sU"; $parts = explode("<", $info[0]['mailauthorizedaddress'][$i], 2); $ident['full_name'] = $parts[0]; if( ($r = preg_match($rx, $info[0]['mailauthorizedaddress'][$i], $results)) == 1) { $tmp1 = str_replace('<', '', $results[0]); $ident['email_address'] = str_replace('>', '', $tmp1); } else { print "Malformed mailAuthorized Address on the LDAP server. Please contact your administrator."; } } $identities[$ident['email_address']] = $ident; if(isset($m)) { $identities_map[$m] = $ident['email_address']; $m++; } else { $m = 1; $identities_map[$m] = $ident['email_address']; $m++; } unset ($ident); } } /* Special feature for 'identity' */ if (isset($info[0]['mailpreferred'][0])) { if(array_key_exists($info[0]['mailpreferred'][0], $identities) && isset($identities_map) ) { foreach($identities_map as $no => $ma) { if($ma == $info[0]['mailpreferred'][0]) { $prefs['identity'] = $no; break; } } } } // $prefs['authorizedemails'][] = $info[0]['mailauthorizedaddress'][$i]; // $prefs['alternateemails'][] = $info[0]['mailauthorizedaddress'][$i]; // $prefs['alternateemails']['count']++; /* TODO: Move this out of ldap_prefs_cache */ if (isset($identities)) { $extra['identities'] = $identities; } if (isset($identities_map)) { $extra['identities_map'] = $identities_map; } if (isset($info[0]['mailauthorizedreplyto']['count'])) { for($i=0; $i<$info[0]['mailauthorizedreplyto']['count'] ; $i++) { $extra['authorizedreplyto'][] = $info[0]['mailauthorizedreplyto'][$i]; } } /* Use the dn that was returned from previous search */ if(isset($info[0]['dn'])) { $user_dn = $info[0]['dn']; $extra['dn'] = $info[0]['dn']; } else { /* This should not be reached at any time... */ print "Warning: Could not get dn for user $uid"; } /* If first time logged in, add me to the SquirrelMailUser objectclass. * */ if(!$already_member) { $newinfo = array(); $newinfo['objectclass'] = array(); for($i = 0; $i < $info[0]['objectclass']['count']; $i++) { $newinfo['objectclass'][$i] = $info[0]['objectclass'][$i]; } $newinfo['objectclass'][$i] = $ldap_objectclass; $ldap2 = ldapuserdata_ldap_connect('manager', true); if(!ldap_modify($ldap2, $user_dn , $newinfo)) { $errormsg = "Error while updating your objectclass! Could not modify LDAP data."; ldap_close($ldap2); exit; } ldap_close($ldap2); /* Plugins or other scripts, e.g. an enhanced motd plugin, can * use the first_time_user variable; this way they know that * this is the first time this user has logged on to the * webmail service. */ $first_time_user = true; sqsession_register($first_time_user, 'first_time_user'); } /* Store $prefs to $user_prefs */ $user_prefs = $prefs; /* Store rest of info to $extra_info */ $extra_info = $extra; return true; } /** * Write user data to LDAP Directory. * * @return void */ function ldapuserdata_write_do() { global $ldap_host, $ldap_objectclass, $prefs_default, $ldap_attributes, $boolean_attrs, $languages, $default_charset; if(isset($_SESSION['authz']) ) { $authz = $_SESSION['authz']; } if(isset($_SESSION['ldap_prefs_cache'])) { $ldap_prefs_cache = $_SESSION['ldap_prefs_cache']; } if(isset($_SESSION['prefs_before'])) { $prefs_before = $_SESSION['prefs_before']; } /* prepare data */ $attr_to_write = array(); $attr_to_del = array(); /* Know which charset we convert from, to UTF-8 */ if(isset($prefs['language'])) { $mycharset = $languages[$prefs['language']]['CHARSET']; } else { $mycharset = $default_charset; } while(list($ldapattr, $squirrelattr) = each($ldap_attributes)) { if( !( ($ldapattr == "cn") || ($ldapattr == "mail") || ($ldapattr == "mailhost")) ) { // echo "Checking $squirrelattr: ".$ldap_prefs_cache[$squirrelattr]." vs ".$prefs_before[$squirrelattr]."
"; if(( isset($ldap_prefs_cache[$squirrelattr]) && isset($prefs_before[$squirrelattr]) && $ldap_prefs_cache[$squirrelattr] != $prefs_before[$squirrelattr] )|| (isset($ldap_prefs_cache[$squirrelattr]) && !isset($prefs_before[$squirrelattr]) ) ) { if ($ldap_prefs_cache[$squirrelattr] != "" ) { $attr_to_write[$ldapattr] = mb_convert_encoding($ldap_prefs_cache[$squirrelattr], "UTF-8", $mycharset); } else { $attr_to_del[$ldapattr] = array(); } } } } /* Handle boolean attributes */ while(list($ldapattr, $squirrelattr) = each($boolean_attrs)) { if( array_key_exists($ldapattr, $attr_to_write) ) { if($attr_to_write[$ldapattr]) { $attr_to_write[$ldapattr] = 'TRUE'; } else { $attr_to_write[$ldapattr] = 'FALSE'; } } } /* Handle multivalue attributes */ /* Mailfetch */ if(isset($ldap_prefs_cache['mailfetch_server_number']) && $ldap_prefs_cache['mailfetch_server_number'] > 0) { //print "putting mailfetch vars"; for ($i=0; $i < $ldap_prefs_cache['mailfetch_server_number']; $i++) { //print "writing # $i"; $newarray[0] = $ldap_prefs_cache['mailfetch_server_'.$i]; $newarray[1] = $ldap_prefs_cache['mailfetch_alias_'.$i]; $newarray[2] = $ldap_prefs_cache['mailfetch_user_'.$i]; $newarray[3] = $ldap_prefs_cache['mailfetch_pass_'.$i]; $newarray[4] = $ldap_prefs_cache['mailfetch_cypher_'.$i]; $newarray[5] = $ldap_prefs_cache['mailfetch_lmos_'.$i]; $newarray[6] = $ldap_prefs_cache['mailfetch_login_'.$i]; $newarray[7] = $ldap_prefs_cache['mailfetch_fref_'.$i]; $newarray[8] = $ldap_prefs_cache['mailfetch_subfolder_'.$i]; $newarray[9] = $ldap_prefs_cache['mailfetch_uidl_'.$i]; $mailfetchpref[$i] = serialize ($newarray); } for($i=0; $i"; print_r($attr_to_write); print ""; } if(!(sizeof($attr_to_del) == 0)) { // print "I will clear these on LDAP:"; // print "
"; print_r($attr_to_del); print "
"; } if(!(sizeof($attr_to_write) == 0)) { $ldap = ldapuserdata_ldap_connect('manager', true); // $objarr = array("objectClass"); /* Check if we have objectClass $ldap_objectclass (default: SquirrelMailUser) */ // if (!($sr = ldap_search($ldap, $ldap_base_dn, "UID=$username", array("objectClass")))) { // print "Cound not get objectclass values for $username."; // exit; // } // $objectclassinfo = ldap_get_entries($ldap, $sr); // print "DEBUG: I will now execute ldap_modify (ldap, $user_dn, attr_to_write)"; if(!ldap_modify($ldap, $user_dn, $attr_to_write)) { print "ERROR: While writing your preferences, an error had occured on the LDAP server.
Please contact your administrator."; } if(sizeof($attr_to_del) == 0) { ldap_close($ldap); } } if(!(sizeof($attr_to_del) == 0)) { if(sizeof($attr_to_write) == 0) { $ldap = ldapuserdata_ldap_connect('manager', true); } if(!ldap_mod_del($ldap, $user_dn, $attr_to_del)) { print "ERROR: While writing your preferences, an error had occured on the LDAP server.
Please contact your administrator."; } ldap_close($ldap); } } /** * Display which preferences are to be saved to LDAP. * * @return string Message with the changed preference items, to be displayed * * @todo Does not work yet; fix it. */ function ldapuserdata_displaychangedprefs() { global $color, $logoutmsg; // TODO - use logoutmsg facility of Squirrelmail // $logoutmsg = "Tralala. :-D"; $out = html_tag( 'table', html_tag( 'tr', html_tag( 'th', _("Sign Out"), 'center' ) , '', $color[0], 'width="100%"' ) . html_tag( 'tr', html_tag( 'td', $logoutmsg , 'center' ) , '', $color[4], 'width="100%"' ) . html_tag( 'tr', html_tag( 'td', '
', 'center' ) , '', $color[0], 'width="100%"' ) , 'center', $color[4], 'width="50%" cols="1" cellpadding="2" cellspacing="0" border="0"' ); return $logoutmsg; } ?>