<?php
/**************************************************************************\
* phpGroupWare API - Accounts manager for SQL *
* This file written by Joseph Engo <jengo@phpgroupware.org> *
* View and manipulate contact records using SQL *
* Copyright (C) 2001 Joseph Engo *
* -------------------------------------------------------------------------*
* This library is part of the phpGroupWare API *
* http://www.phpgroupware.org/api *
* ------------------------------------------------------------------------ *
* This library is free software; you can redistribute it and/or modify it *
* under the terms of the GNU Lesser General Public License as published by *
* the Free Software Foundation; either version 2.1 of the License, *
* or any later version. *
* This library is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. *
* See the GNU Lesser General Public License for more details. *
* You should have received a copy of the GNU Lesser General Public License *
* along with this library; if not, write to the Free Software Foundation, *
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
\**************************************************************************/
/* $Id$ */
/*!
@class acl
@abstract Contact List System
@discussion Author: jengo/Milosch <br>
This class provides a contact database scheme. <br>
It attempts to be based on the vcard 2.1 standard, with mods as needed to make for more reasonable sql storage. <br>
Syntax: CreateObject('phpgwapi.contacts'); <br>
Example1: $contacts = CreateObject('phpgwapi.contacts');
*/
class contacts_
{
var $db;
var $ldap;
var $nextid;
var $std_table="";
var $ext_table="phpgw_addressbook_extra";
var $account_id;
var $stock_contact_fields; // This is an array of almost the fields in the phpgw_addressbook table, except id,owner,lid,tid
var $email_types; // VCard email type array
var $total_records; // This will contain numrows for data retrieved
function contacts_()
{
global $phpgw, $phpgw_info;
$this->db = $phpgw->db;
$this->ldap = $phpgw->common->ldapConnect(
$phpgw_info['server']['ldap_contact_host'],
$phpgw_info['server']['ldap_contact_dn'],
$phpgw_info['server']['ldap_contact_pw']
);
$this->account_id = $phpgw_info["user"]["account_id"];
// The left side are the array elements used throughout phpgw, right side are the ldap attributes
$this->stock_contact_fields = array(
"id" => "uidnumber",
"lid" => "uid",
"tid" => "phpgwcontacttype",
"owner" => "phpgwowner",
"fn" => "cn", // 'prefix given middle family suffix'
"n_given" => "givenname", // firstname
"n_family" => "sn", // lastname
"n_middle" => "middlename",
"n_prefix" => "prefix",
"n_suffix" => "suffix",
"sound" => "audio",
"bday" => "birthday",
"note" => "description",
"tz" => "tz",
"geo" => "geo",
"url" => "url",
"pubkey" => "publickey",
"org_name" => "phpgworgname", // company
"org_unit" => "phpgworgunit", // division
"title" => "title",
"adr_one_street" => "street",
"adr_one_locality" => "locality",
"adr_one_region" => "st",
"adr_one_postalcode" => "postalcode",
"adr_one_countryname" => "countryname",
"adr_one_type" => "phpgwadronetype", // address is domestic/intl/postal/parcel/work/home
"label" => "phpgwaddresslabel", // address label
"adr_two_street" => "phpgwadrtwostreet",
"adr_two_locality" => "phpgwadrtwolocality",
"adr_two_region" => "phpgwadrtworegion",
"adr_two_postalcode" => "phpgwadrtwopostalcode",
"adr_two_countryname" => "phpgwadrtwocountryname",
"adr_two_type" => "phpgwadrtwotype", // address is domestic/intl/postal/parcel/work/home
"tel_work" => "telephonenumber",
"tel_home" => "homephone",
"tel_voice" => "voicetelephonenumber",
"tel_fax" => "facsimiletelephonenumber",
"tel_msg" => "msgtelephonenumber",
"tel_cell" => "cellphone",
"tel_pager" => "pagertelephonenumber",
"tel_bbs" => "bbstelephonenumber",
"tel_modem" => "modemtelephonenumber",
"tel_car" => "mobiletelephonenumber",
"tel_isdn" => "isdnphonenumber",
"tel_video" => "videophonenumber",
"tel_prefer" => "preferphone", // home, work, voice, etc
"email" => "mail",
"email_type" => "mailtype", //'INTERNET','CompuServe',etc...
"email_home" => "mailhome",
"email_home_type" => "mailhometype" //'INTERNET','CompuServe',etc...
);
/* Used to flag an address as being:
domestic OR international(default)
parcel(default)
postal(default)
work(default) OR home
*/
$this->adr_types = array(
"dom" => lang("Domestic"),
"intl" => lang("International"),
"parcel" => lang("Parcel"),
"postal" => lang("Postal")
);
// Used to set preferphone field
$this->tel_types = array(
"work" => "work",
"home" => "home",
"voice" => "voice",
"fax" => "fax",
"msg" => "msg",
"cell" => "cell",
"pager" => "pager",
"bbs" => "bbs",
"modem" => "modem",
"car" => "car",
"isdn" => "isdn",
"video" => "video"
);
// Used to set mail_type fields
$this->email_types = array(
"INTERNET" => "INTERNET",
"CompuServe" => "CompuServe",
"AOL" => "AOL",
"Prodigy" => "Prodigy",
"eWorld" => "eWorld",
"AppleLink" => "AppleLink",
"AppleTalk" => "AppleTalk",
"PowerShare" => "PowerShare",
"IBMMail" => "IBMMail",
"ATTMail" => "ATTMail",
"MCIMail" => "MCIMail",
"X.400" => "X.400",
"TLX" => "TLX"
);
}
// send this the id and whatever fields you want to see
function read_single_entry($id,$fields="")
{
global $phpgw_info;
if (!$fields || empty($fields)) { $fields = $this->stock_contact_fields; }
list($stock_fields,$stock_fieldnames,$extra_fields) =
$this->split_stock_and_extras($fields);
if (count($stock_fieldnames)) {
$t_fields = "," . implode(",",$stock_fieldnames);
if ($t_fields == ",") {
unset($t_fields);
}
}
$sri = ldap_search($this->ldap, $phpgw_info["server"]["ldap_contact_context"], "uidnumber=".$id);
$ldap_fields = ldap_get_entries($this->ldap, $sri);
if (gettype($stock_fieldnames) == "array") {
while(list($name,$value)=each($stock_fieldnames)) {
$return_fields[0][$name] = $ldap_fields[0][$value][0];
}
}
// Setup address type fields
if ($return_fields[0]["adr_one_type"]) {
$one_type = $return_fields[0]["adr_one_type"];
reset($this->adr_types);
while (list($name,$val) = each($this->adr_types)) {
eval("if (strstr(\$one_type,\$name)) { \$return_fields[0][\"one_\$name\"] = \"on\"; }");
}
}
if ($return_fields[0]["adr_two_type"]) {
$two_type = $return_fields[0]["adr_two_type"];
reset($this->adr_types);
while (list($name,$val) = each($this->adr_types)) {
eval("if (strstr(\$two_type,\$name)) { \$return_fields[0][\"two_\$name\"] = \"on\"; }");
}
}
$this->db->query("select contact_name,contact_value from $this->ext_table where contact_id='" . $id . "'",__LINE__,__FILE__);
while ($this->db->next_record()) {
// If its not in the list to be returned, don't return it.
// This is still quicker then 5(+) separate queries
if ($extra_fields[$this->db->f("contact_name")]) {
$return_fields[0][$this->db->f("contact_name")] = $this->db->f("contact_value");
}
}
return $return_fields;
}
function read_last_entry($fields="")
{
global $phpgw_info;
if (!$fields || empty($fields)) { $fields = $this->stock_contact_fields; }
list($stock_fields,$stock_fieldnames,$extra_fields) =
$this->split_stock_and_extras($fields);
if (count($stock_fieldnames)) {
$t_fields = "," . implode(",",$stock_fieldnames);
if ($t_fields == ",") {
unset($t_fields);
}
}
$id = $this->nextid;
if ($id == -1) { $id = 1; }
$sri = ldap_search($this->ldap, $phpgw_info["server"]["ldap_contact_context"], "uidnumber=".$id);
$ldap_fields = ldap_get_entries($this->ldap, $sri);
if (gettype($stock_fieldnames) == "array") {
while(list($name,$value)=each($stock_fieldnames)) {
$return_fields[0][$name] = $ldap_fields[0][$value][0];
}
}
// Setup address type fields
if ($return_fields[0]["adr_one_type"]) {
$one_type = $return_fields[0]["adr_one_type"];
reset($this->adr_types);
while (list($name,$val) = each($this->adr_types)) {
eval("if (strstr(\$one_type,\$name)) { \$return_fields[0][\"one_\$name\"] = \"on\"; }");
}
}
if ($return_fields[0]["adr_two_type"]) {
$two_type = $return_fields[0]["adr_two_type"];
reset($this->adr_types);
while (list($name,$val) = each($this->adr_types)) {
eval("if (strstr(\$two_type,\$name)) { \$return_fields[0][\"two_\$name\"] = \"on\"; }");
}
}
$this->db->query("select contact_name,contact_value from $this->ext_table where contact_id='" . $id . "'",__LINE__,__FILE__);
while ($this->db->next_record()) {
// If its not in the list to be returned, don't return it.
// This is still quicker then 5(+) separate queries
if ($extra_fields[$this->db->f("contact_name")]) {
$return_fields[0][$this->db->f("contact_name")] = $this->db->f("contact_value");
}
}
return $return_fields;
}
// send this the range, query, sort, order and whatever fields you want to see
// 'rights' is unused at this time
function read($start=0,$offset=0,$fields="",$query="",$filter="",$sort="",$order="",$rights="")
{
global $phpgw,$phpgw_info;
if (!$fields || empty($fields)) { $fields = $this->stock_contact_fields; }
$DEBUG = 0;
list($stock_fields,$stock_fieldnames,$extra_fields) = $this->split_stock_and_extras($fields);
if (count($stock_fieldnames)) {
$t_fields = "," . implode(",",$stock_fieldnames);
if ($t_fields == ",") {
unset($t_fields);
}
}
// turn filter's a=b,c=d OR a=b into an array
if ($filter) {
if ($DEBUG) { echo "DEBUG - Inbound filter is: #".$filter."#"; }
$filterarray = split(',',$filter);
if ($filterarray[1]) {
$i=0;
for ($i=0;$i<count($filterarray);$i++) {
list($name,$value) = split("=",$filterarray[$i]);
if ($name) {
if ($DEBUG) { echo "<br>DEBUG - Filter intermediate strings 1: #".$name."# => #".$value."#"; }
$filterfields[$name] = $value;
}
}
} else {
list($name,$value) = split('=',$filter);
if ($DEBUG) {
echo "<br>DEBUG - Filter intermediate strings 1: #".$name."# => #".$value."#";
}
$filterfields = array($name => $value);
}
// now check each element of the array and convert into SQL for queries
// below
$i=0;
reset($filterfields);
while (list($name,$value) = each($filterfields)) {
if ($DEBUG) { echo "<br>DEBUG - Filter intermediate strings 2: #".$name."# => #".$value."#"; }
$isstd=0;
if ($name && empty($value)) {
if ($DEBUG) { echo "<br>DEBUG - filter field '".$name."' is empty (NULL)"; }
$check_stock = $this->stock_contact_fields + array('id' => 'id', 'tid' => 'tid', 'lid' => 'lid', 'owner' => 'owner');
while (list($fname,$fvalue)=each($check_stock)) {
if ($fvalue==$name) {
$filterlist .= $name.' is NULL,';
if ($DEBUG) { echo "<br>DEBUG - filter field '".$name."' is a stock field"; }
break;
}
}
} elseif($name && $value) {
reset($stock_fields);
while (list($fname,$fvalue)=each($stock_fields)) {
if ($fvalue==$name) {
$filterlist .= $name.'="'.$value.'",';
break;
}
}
}
$i++;
}
$filterlist = substr($filterlist,0,-1);
$filterlist = ereg_replace(","," AND ",$filterlist);
if ($DEBUG) {
echo "<br>DEBUG - Filter output string: #".$filterlist."#";
}
if ($filterlist) {
$filtermethod = '('.$filterlist.') ';
$fwhere = ' WHERE '; $fand = ' AND ';
}
}
if ($DEBUG && $filtermethod) {
echo "<br>DEBUG - Filtering with: #" . $filtermethod . "#";
}
if (!$sort) { $sort = "ASC"; }
if ($order) {
$ordermethod = "order by $order $sort ";
} else {
$ordermethod = "order by n_family,n_given,email $sort";
}
if ($DEBUG && $ordermethod) {
echo "<br>DEBUG - $ordermethod";
}
// This logic allows you to limit rows, or not.
// The export feature, for example, does not limit rows.
// This way, it can retrieve all rows at once.
if ($start && $offset) {
//$limit = $this->db->limit($start,$offset);
} elseif ($start && !$offset) {
$limit = "";
} elseif(!$start && !$offset) {
$limit = $this->total_records;
} else { #(!$start && $offset) {
$start = 0;
//$limit = $this->db->limit($start,$offset);
}
$this->db3 = $this->db2 = $this->db; // Create new result objects before our queries
/*
if ($query) {
$this->db3->query("SELECT * FROM $this->std_table WHERE (n_family LIKE '"
. "%$query%' OR n_given LIKE '%$query%' OR email LIKE '%$query%' OR "
. "adr_one_street LIKE '%$query%' OR adr_one_locality LIKE '%$query%' OR adr_one_region LIKE '%$query%' OR "
. "adr_one_postalcode LIKE '%$query%' OR adr_one_countryname LIKE '%$query%' OR "
. "adr_two_street LIKE '%$query%' OR adr_two_locality LIKE '%$query%' OR adr_two_region LIKE '%$query%' OR "
. "adr_two_postalcode LIKE '%$query%' OR adr_two_countryname LIKE '%$query%' OR "
. "org_name LIKE '%$query%' OR org_unit LIKE '%$query%') " . $fand . $filtermethod . $ordermethod,__LINE__,__FILE__);
$this->total_records = $this->db3->num_rows();
$this->db->query("SELECT * FROM $this->std_table WHERE (n_family LIKE '"
. "%$query%' OR n_given LIKE '%$query%' OR email LIKE '%$query%' OR "
. "adr_one_street LIKE '%$query%' OR adr_one_locality LIKE '%$query%' OR adr_one_region LIKE '%$query%' OR "
. "adr_one_postalcode LIKE '%$query%' OR adr_one_countryname LIKE '%$query%' OR "
. "adr_two_street LIKE '%$query%' OR adr_two_locality LIKE '%$query%' OR adr_two_region LIKE '%$query%' OR "
. "adr_two_postalcode LIKE '%$query%' OR adr_two_countryname LIKE '%$query%' OR "
. "org_name LIKE '%$query%' OR org_unit LIKE '%$query%') " . $fand . $filtermethod . $ordermethod . " "
. $limit,__LINE__,__FILE__);
} else {
$this->db3->query("SELECT id,lid,tid,owner $t_fields FROM $this->std_table " . $fwhere
. $filtermethod,__LINE__,__FILE__);
$this->total_records = $this->db3->num_rows();
$this->db->query("SELECT id,lid,tid,owner $t_fields FROM $this->std_table " . $fwhere
. $filtermethod . " " . $ordermethod . " " . $limit,__LINE__,__FILE__);
}
*/
$sri = ldap_search($this->ldap, $phpgw_info["server"]["ldap_contact_context"], "phpgwowner=*");
$ldap_fields = ldap_get_entries($this->ldap, $sri);
$this->total_records = ldap_count_entries($this->ldap, $sri);
// This logic allows you to limit rows, or not.
// The export feature, for example, does not limit rows.
// This way, it can retrieve all rows at once.
if ($start && $offset) {
$limit = $start + $offset;;
} elseif ($start && !$offset) {
$limit = $start;
} elseif(!$start && !$offset) {
$limit = $this->total_records;
} else { #(!$start && $offset) {
$start = 0;
$limit = $offset;
}
//echo '('.$start.','.$limit.')';
reset($ldap_fields);
$j=0;
for ($i=$start;$i<$limit;$i++) {
if ($i<$this->total_records && $ldap_fields[$i]["uid"][0]) {
//echo '<br>j:'.$j;
// unique id, lid for group/account records,
// type id (g/u) for groups/accounts, and
// id of owner/parent for the record
$return_fields[$j]["id"] = $ldap_fields[$i]["uidnumber"][0];
$return_fields[$j]["lid"] = $ldap_fields[$i]["uid"][0];
$return_fields[$j]["tid"] = $ldap_fields[$i]["phpgwcontacttype"][0];
$return_fields[$j]["owner"] = $ldap_fields[$i]["phpgwowner"][0];
if (gettype($stock_fieldnames) == "array") {
while (list($f_name,$f_value) = each($stock_fieldnames)) {
$return_fields[$j][$f_name] = $ldap_fields[$i][$f_value][0];
}
reset($stock_fieldnames);
}
$this->db2->query("SELECT contact_name,contact_value FROM $this->ext_table WHERE contact_id='"
. $ldap_fields[$i]["id"] . "'",__LINE__,__FILE__);
while ($this->db2->next_record()) {
// If its not in the list to be returned, don't return it.
// This is still quicker then 5(+) separate queries
if ($extra_fields[$this->db2->f("contact_name")]) {
$return_fields[$j][$this->db2->f("contact_name")] = $this->db2->f("contact_value");
}
}
$j++;
}
}
return $return_fields;
}
function add($owner,$fields)
{
global $phpgw,$phpgw_info;
list($stock_fields,$stock_fieldnames,$extra_fields) = $this->split_stock_and_extras($fields);
$free = 0;
// Loop until we find a free id
while (!$free) {
$sri = ldap_search($this->ldap, $phpgw_info["server"]["ldap_contact_context"], "uidnumber=".$this->nextid);
$ldap_fields = ldap_get_entries($this->ldap, $sri);
if ($ldap_fields[0]['dn'][0]) {
$this->nextid = $phpgw->common->next_id("contacts");
next;
} else {
$this->nextid = $phpgw->common->next_id("contacts");
$free = True;
}
}
$ldap_fields = '';
if (gettype($stock_fieldnames) == "array") {
while(list($name,$value)=each($stock_fieldnames)) {
$ldap_fields[$value] = $stock_fields[$name];
}
}
$time = gettimeofday();
$ldap_fields['uid'] = time().$time["usec"].":".$ldap_fields['givenname'];
$dn = 'uid=' . $ldap_fields['uid'].',' . $phpgw_info["server"]["ldap_contact_context"];
$ldap_fields['phpgwowner'] = $owner;
$ldap_fields['uidnumber'] = $this->nextid;
$ldap_fields['objectclass'][0] = 'person';
$ldap_fields['objectclass'][1] = 'organizationalPerson';
$ldap_fields['objectclass'][2] = 'inetOrgPerson';
$ldap_fields['objectclass'][3] = 'phpgwContact';
/*
while (list($name,$value) = each($ldap_fields) ) {
echo '<br>fieldname ="'.$name.'", value ="'.$value.'"';
}
exit;
*/
$err = ldap_add($this->ldap, $dn, $ldap_fields);
//$this->db->unlock();
if (count($extra_fields)) {
while (list($name,$value) = each($extra_fields)) {
$this->db->query("insert into $this->ext_table values ('".$this->nextid."','" . $this->account_id . "','"
. addslashes($name) . "','" . addslashes($value) . "')",__LINE__,__FILE__);
}
}
}
function field_exists($id,$field_name)
{
$this->db->query("select count(*) from $this->ext_table where contact_id='$id' and contact_name='"
. addslashes($field_name) . "'",__LINE__,__FILE__);
$this->db->next_record();
return $this->db->f(0);
}
function add_single_extra_field($id,$owner,$field_name,$field_value)
{
$this->db->query("insert into $this->ext_table values ($id,'$owner','" . addslashes($field_name)
. "','" . addslashes($field_value) . "')",__LINE__,__FILE__);
}
function delete_single_extra_field($id,$field_name)
{
$this->db->query("delete from $this->ext_table where contact_id='$id' and contact_name='"
. addslashes($field_name) . "'",__LINE__,__FILE__);
}
function update($id,$owner,$fields)
{
global $phpgw_info;
// First make sure that id number exists
$sri = ldap_search($this->ldap, $phpgw_info["server"]["ldap_contact_context"], "uidnumber=".$id);
$ldap_fields = ldap_get_entries($this->ldap, $sri);
if ($ldap_fields[0]['dn']) {
$dn = $ldap_fields[0]['dn'];
list($stock_fields,$stock_fieldnames,$extra_fields) = $this->split_stock_and_extras($fields);
if (gettype($stock_fieldnames) == "array") {
$stock_fields['phpgwowner'] = $owner;
// Check each value, add our extra attributes if they are missing, and
// otherwise fix the entry while we can
// Verify uidnumber
if (empty($ldap_fields[0]['uidnumber'])) {
$stock_fields['uidnumber'] = $id;
$err = ldap_modify($this->ldap,$dn,array('uidnumber' => $stock_fields['uidnumber']));
} elseif (!$ldap_fields[0]['uidnumber']) {
$stock_fields['uidnumber'] = $id;
$err = ldap_mod_add($this->ldap,$dn,array('uidnumber' => $stock_fields['uidnumber']));
}
// Verify uid
if (empty($ldap_fields[0]['uid'])) {
$uids = split(',',$dn);
$stock_fields['uid'] = $uids[0];
$err = ldap_modify($this->ldap,$dn,array('uid' => $stock_fields['uid']));
} elseif (!$ldap_fields[0]['uid']) {
$uids = split(',',$dn);
$stock_fields['uid'] = $uids[0];
$err = ldap_mod_add($this->ldap,$dn,array('uid' => $stock_fields['uid']));
}
// Verify owner
if (empty($ldap_fields[0]['owner'])) {
$stock_fields['phpgwowner'] = $owner;
$err = ldap_modify($this->ldap,$dn,array('owner' => $stock_fields['phpgwowner']));
} elseif (!$ldap_fields[0]['owner']) {
$stock_fields['phpgwowner'] = $owner;
$err = ldap_mod_add($this->ldap,$dn,array('owner' => $stock_fields['phpgwowner']));
}
// Verify objectclasses are there
if (empty($ldap_fields[0]['objectclass'])) {
$stock_fields['objectclass'][0] = 'person';
$stock_fields['objectclass'][1] = 'organizationalPerson';
$stock_fields['objectclass'][2] = 'inetOrgPerson';
$stock_fields['objectclass'][3] = 'phpgwContact';
$err = ldap_modify($this->ldap,$dn,array('objectclass' => $stock_fields['objectclass']));
} elseif (!$ldap_fields[0]['objectclass']) {
$stock_fields['objectclass'][0] = 'person';
$stock_fields['objectclass'][1] = 'organizationalPerson';
$stock_fields['objectclass'][2] = 'inetOrgPerson';
$stock_fields['objectclass'][3] = 'phpgwContact';
$err = ldap_mod_add($this->ldap,$dn,array('objectclass' => $stock_fields['objectclass']));
}
// OK, just add the data already
while ( list($fname,$fvalue) = each($stock_fieldnames) ) {
if ($ldap_fields[0][$fvalue]) {
//echo "<br>".$fname." was there";
$err = ldap_modify($this->ldap,$dn,array($fvalue => $stock_fields[$fname]));
} elseif (!$ldap_fields[0][$fvalue]) {
//echo "<br>".$fname." not there";
$err = ldap_mod_add($this->ldap,$dn,array($fvalue => $stock_fields[$fname]));
}
}
}
while (list($x_name,$x_value) = each($extra_fields)) {
if ($this->field_exists($id,$x_name)) {
if (! $x_value) {
$this->delete_single_extra_field($id,$x_name);
} else {
$this->db->query("update $this->ext_table set contact_value='" . addslashes($x_value)
. "',contact_owner='$owner' where contact_name='" . addslashes($x_name)
. "' and contact_id='$id'",__LINE__,__FILE__);
}
} else {
$this->add_single_extra_field($id,$owner,$x_name,$x_value);
}
}
} else {
return False;
}
}
// This is where the real work of delete() is done, shared class file contains calling function
function delete_($id)
{
global $phpgw_info;
$sri = ldap_search($this->ldap, $phpgw_info["server"]["ldap_contact_context"], "uidnumber=".$id);
$ldap_fields = ldap_get_entries($this->ldap, $sri);
if ($ldap_fields[0]['dn']) {
$err = ldap_delete($this->ldap,$ldap_fields[0]['dn']);
$this->db->query("delete from $this->ext_table where contact_id='$id' and contact_owner='"
. $this->account_id . "'",__LINE__,__FILE__);
} else {
return False;
}
}
}
?>