egroupware_official/phpgwapi/inc/class.accounts_sql.inc.php
2004-05-05 12:06:13 +00:00

411 lines
14 KiB
PHP

<?php
/**************************************************************************\
* eGroupWare API - Accounts manager for SQL *
* Written by Joseph Engo <jengo@phpgroupware.org> *
* and Dan Kuykendall <seek3r@phpgroupware.org> *
* and Bettina Gille [ceb@phpgroupware.org] *
* View and manipulate account records using SQL *
* Copyright (C) 2000 - 2002 Joseph Engo *
* Copyright (C) 2003 Joseph Engo, Bettina Gille *
* ------------------------------------------------------------------------ *
* This library is part of the eGroupWare API *
* http://www.egroupware.org *
* ------------------------------------------------------------------------ *
* 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_start accounts
@abstract Class for handling user and group accounts
*/
class accounts_
{
var $db;
var $account_id;
var $data;
var $total;
function accounts_()
{
copyobj($GLOBALS['phpgw']->db,$this->db);
}
function list_methods($_type='xmlrpc')
{
if (is_array($_type))
{
$_type = $_type['type'] ? $_type['type'] : $_type[0];
}
switch($_type)
{
case 'xmlrpc':
$xml_functions = array(
'get_list' => array(
'function' => 'get_list',
'signature' => array(array(xmlrpcStruct)),
'docstring' => lang('Returns a full list of accounts on the system. Warning: This is return can be quite large')
),
'list_methods' => array(
'function' => 'list_methods',
'signature' => array(array(xmlrpcStruct,xmlrpcString)),
'docstring' => lang('Read this list of methods.')
)
);
return $xml_functions;
break;
case 'soap':
return $this->soap_functions;
break;
default:
return array();
break;
}
}
/*!
@function read_repository
@abstract grabs the records from the data store
*/
function read_repository()
{
$this->db->query('SELECT * FROM phpgw_accounts WHERE account_id=' . (int)$this->account_id,__LINE__,__FILE__);
$this->db->next_record();
$this->data['userid'] = $this->db->f('account_lid');
$this->data['account_id'] = $this->db->f('account_id');
$this->data['account_lid'] = $this->db->f('account_lid');
$this->data['firstname'] = $this->db->f('account_firstname');
$this->data['lastname'] = $this->db->f('account_lastname');
$this->data['fullname'] = $this->db->f('account_firstname') . ' ' . $this->db->f('account_lastname');
$this->data['lastlogin'] = $this->db->f('account_lastlogin');
$this->data['lastloginfrom'] = $this->db->f('account_lastloginfrom');
$this->data['lastpasswd_change'] = $this->db->f('account_lastpwd_change');
$this->data['status'] = $this->db->f('account_status');
$this->data['expires'] = $this->db->f('account_expires');
$this->data['person_id'] = $this->db->f('person_id');
$this->data['account_primary_group'] = $this->db->f('account_primary_group');
return $this->data;
}
/*!
@function save_repository
@abstract saves the records to the data store
*/
function save_repository()
{
$this->db->query('UPDATE phpgw_accounts SET'
. " account_firstname='" . $this->db->db_addslashes($this->data['firstname'])
. "', account_lastname='" . $this->db->db_addslashes($this->data['lastname'])
. "', account_status='". $this->db->db_addslashes($this->data['status'])
. "', account_expires=" . (int)$this->data['expires']
. ($this->data['account_lid']?", account_lid='".$this->db->db_addslashes($this->data['account_lid'])."'":'')
. ', person_id='.(int)$this->data['person_id']
. ', account_primary_group='.(int)$this->data['account_primary_group']
. ' WHERE account_id=' . (int)$this->account_id,__LINE__,__FILE__);
}
function delete($accountid = '')
{
$account_id = get_account_id($accountid);
/* Do this last since we are depending upon this record to get the account_lid above */
$tables_array = Array('phpgw_accounts');
$this->db->lock($tables_array);
$this->db->query('DELETE FROM phpgw_accounts WHERE account_id=' . (int)$account_id,__LINE__,__FILE__);
$this->db->unlock();
}
function get_list($_type='both',$start = '',$sort = '', $order = '', $query = '', $offset = '')
{
if (! $sort)
{
$sort = "DESC";
}
if (!empty($order) && preg_match('/^[a-zA-Z_0-9, ]+$/',$order) && (empty($sort) || preg_match('/^(DESC|ASC|desc|asc)$/',$sort)))
{
$orderclause = "ORDER BY $order $sort";
}
else
{
$orderclause = "ORDER BY account_lid ASC";
}
switch($_type)
{
case 'accounts':
$whereclause = "WHERE account_type = 'u'";
break;
case 'groups':
$whereclause = "WHERE account_type = 'g'";
break;
default:
$whereclause = '';
}
if ($query)
{
if ($whereclause)
{
$whereclause .= ' AND ( ';
}
else
{
$whereclause = ' WHERE ( ';
}
$query = $this->db->db_addslashes($query);
$whereclause .= " account_firstname LIKE '%$query%' OR account_lastname LIKE "
. "'%$query%' OR account_lid LIKE '%$query%' )";
}
$sql = "SELECT * FROM phpgw_accounts $whereclause $orderclause";
if ($offset)
{
$this->db->limit_query($sql,$start,__LINE__,__FILE__,$offset);
}
elseif ($start !== '')
{
$this->db->limit_query($sql,$start,__LINE__,__FILE__);
}
else
{
$this->db->query($sql,__LINE__,__FILE__);
}
while ($this->db->next_record())
{
$accounts[] = Array(
'account_id' => $this->db->f('account_id'),
'account_lid' => $this->db->f('account_lid'),
'account_type' => $this->db->f('account_type'),
'account_firstname' => $this->db->f('account_firstname'),
'account_lastname' => $this->db->f('account_lastname'),
'account_status' => $this->db->f('account_status'),
'account_expires' => $this->db->f('account_expires'),
'person_id' => $this->db->f('person_id'),
'account_primary_group' => $this->db->f('account_primary_group')
);
}
$this->db->query("SELECT count(*) FROM phpgw_accounts $whereclause");
$this->db->next_record();
$this->total = $this->db->f(0);
return $accounts;
}
function name2id($account_lid)
{
$this->db->query("SELECT account_id FROM phpgw_accounts WHERE account_lid='".$this->db->db_addslashes($account_lid)."'",__LINE__,__FILE__);
if($this->db->num_rows())
{
$this->db->next_record();
return (int)$this->db->f('account_id');
}
return False;
}
function id2name($account_id)
{
$this->db->query('SELECT account_lid FROM phpgw_accounts WHERE account_id=' . (int)$account_id,__LINE__,__FILE__);
if($this->db->num_rows())
{
$this->db->next_record();
return $this->db->f('account_lid');
}
return False;
}
function get_type($account_id)
{
$this->db->query('SELECT account_type FROM phpgw_accounts WHERE account_id=' . (int)$account_id,__LINE__,__FILE__);
if ($this->db->num_rows())
{
$this->db->next_record();
return $this->db->f('account_type');
}
return False;
}
function exists($account_lid)
{
static $by_id, $by_lid;
$sql = 'SELECT count(account_id) FROM phpgw_accounts WHERE ';
if(is_numeric($account_lid))
{
if(@isset($by_id[$account_lid]) && $by_id[$account_lid] != '')
{
return $by_id[$account_lid];
}
$sql .= 'account_id=' . $account_lid;
}
else
{
if(@isset($by_lid[$account_lid]) && $by_lid[$account_lid] != '')
{
return $by_lid[$account_lid];
}
$sql .= "account_lid = '".$this->db->db_addslashes($account_lid)."'";
}
$this->db->query($sql,__LINE__,__FILE__);
$this->db->next_record();
$ret_val = $this->db->f(0) > 0;
if(is_numeric($account_lid))
{
$by_id[$account_lid] = $ret_val;
$by_lid[$this->id2name($account_lid)] = $ret_val;
}
else
{
$by_lid[$account_lid] = $ret_val;
$by_id[$this->name2id($account_lid)] = $ret_val;
}
return $ret_val;
}
function create($account_info,$default_prefs=True)
{
$this->db->query('INSERT INTO phpgw_accounts (account_lid,account_type,account_pwd,'
. 'account_firstname,account_lastname,account_status,account_expires,person_id,'
. "account_primary_group) VALUES ('".$this->db->db_addslashes($account_info['account_lid'])
. "','" . $this->db->db_addslashes($account_info['account_type'])
. "','" . $GLOBALS['phpgw']->common->encrypt_password($account_info['account_passwd'], True)
. "', '" . $this->db->db_addslashes($account_info['account_firstname'])
. "','" . $this->db->db_addslashes($account_info['account_lastname'])
. "','" . $this->db->db_addslashes($account_info['account_status'])
. "'," . (int)$account_info['account_expires']
. ',' . (int)$account_info['person_id']
. ',' . (int)$account_info['account_primary_group'] . ')',__LINE__,__FILE__);
$accountid = $this->db->get_last_insert_id('phpgw_accounts','account_id');
/* default prefs dont need to be set anymore
if($accountid && is_object($GLOBALS['phpgw']->preferences) && $default_prefs)
{
$GLOBALS['phpgw']->preferences->create_defaults($accountid);
}
*/
return $accountid;
}
function auto_add($accountname, $passwd, $default_prefs = False, $default_acls = False, $expiredate = 0, $account_status = 'A')
{
if ($expiredate)
{
$expires = mktime(2,0,0,date('n',$expiredate), (int)date('d',$expiredate), date('Y',$expiredate));
}
else
{
if($GLOBALS['phpgw_info']['server']['auto_create_expire'])
{
if($GLOBALS['phpgw_info']['server']['auto_create_expire'] == 'never')
{
$expires = -1;
}
else
{
$expiredate = time() + $GLOBALS['phpgw_info']['server']['auto_create_expire'];
$expires = mktime(2,0,0,date('n',$expiredate), (int)date('d',$expiredate), date('Y',$expiredate));
}
}
else
{
/* expire in 30 days by default */
$expiredate = time() + ( ( 60 * 60 ) * (30 * 24) );
$expires = mktime(2,0,0,date('n',$expiredate), (int)date('d',$expiredate), date('Y',$expiredate));
}
}
$acct_info = array(
'account_lid' => $accountname,
'account_type' => 'u',
'account_passwd' => $passwd,
'account_firstname' => '',
'account_lastname' => '',
'account_status' => $account_status,
'account_expires' => $expires
);
$this->db->transaction_begin();
$this->create($acct_info,$default_prefs);
$accountid = $this->name2id($accountname);
if ($default_acls == False)
{
$default_group_lid = $GLOBALS['phpgw_info']['server']['default_group_lid'];
$default_group_id = $this->name2id($default_group_lid);
$defaultgroupid = $default_group_id ? $default_group_id : $this->name2id('Default');
if ($defaultgroupid)
{
$this->db->query("insert into phpgw_acl (acl_appname, acl_location, acl_account, acl_rights) values('phpgw_group', "
. $defaultgroupid . ', ' . $accountid . ', 1)',__LINE__,__FILE__);
$this->db->query("insert into phpgw_acl (acl_appname, acl_location, acl_account, acl_rights) values('preferences', 'changepassword', " . $accountid . ', 1)',__LINE__,__FILE__);
}
else
{
// If they don't have a default group, they need some sort of permissions.
// This generally doesn't / shouldn't happen, but will (jengo)
$this->db->query("insert into phpgw_acl (acl_appname, acl_location, acl_account, acl_rights) values('preferences', 'changepassword', " . $accountid . ', 1)',__LINE__,__FILE__);
foreach(Array(
'addressbook',
'calendar',
'email',
'notes',
'todo',
'phpwebhosting',
'manual'
) as $app)
{
$this->db->query("INSERT INTO phpgw_acl (acl_appname, acl_location, acl_account, acl_rights) VALUES ('" . $app . "', 'run', " . $accountid . ', 1)',__LINE__,__FILE__);
}
}
}
$this->db->transaction_commit();
$GLOBALS['hook_values']['account_lid'] = $acct_info['account_lid'];
$GLOBALS['hook_values']['account_id'] = $accountid;
$GLOBALS['hook_values']['new_passwd'] = $acct_info['account_passwd'];
$GLOBALS['hook_values']['account_status'] = $acct_info['account_status'];
$GLOBALS['hook_values']['account_firstname'] = $acct_info['account_lid'];
$GLOBALS['hook_values']['account_lastname'] = 'eGW Account';
$GLOBALS['phpgw']->hooks->process($GLOBALS['hook_values']+array(
'location' => 'addaccount'
),False,True); // called for every app now, not only enabled ones
return $accountid;
}
function get_account_name($accountid,&$lid,&$fname,&$lname)
{
$db = $GLOBALS['phpgw']->db;
$db->query('SELECT account_lid,account_firstname,account_lastname FROM phpgw_accounts WHERE account_id=' . (int)$accountid,__LINE__,__FILE__);
if (!$db->next_record())
{
return False;
}
$lid = $db->f('account_lid');
$fname = $db->f('account_firstname');
$lname = $db->f('account_lastname');
return True;
}
}
/*!
@class_end accounts
*/