egroupware/phpgwapi/inc/class.sessions.inc.php

629 lines
19 KiB
PHP
Raw Normal View History

<?php
/**************************************************************************\
2001-01-13 11:18:50 +01:00
* phpGroupWare API - Session management *
* This file written by Dan Kuykendall <seek3r@phpgroupware.org> *
* and Joseph Engo <jengo@phpgroupware.org> *
* Copyright (C) 2000, 2001 Dan Kuykendall *
* -------------------------------------------------------------------------*
* This library is part of the phpGroupWare API *
* http://www.phpgroupware.org/api *
* ------------------------------------------------------------------------ *
2001-01-13 11:18:50 +01:00
* 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 *
\**************************************************************************/
2001-02-12 20:21:45 +01:00
/* $Id$ */
/*
** Reserved session_flags
** A - anonymous session
** N - None, normal session
*/
2001-02-12 20:21:45 +01:00
class sessions
{
var $login;
var $passwd;
var $account_id;
var $account_lid;
var $account_domain;
var $session_flags;
2001-02-12 20:21:45 +01:00
var $sessionid;
var $kp3;
var $data;
var $db;
var $db2;
/*************************************************************************\
* Constructor just loads up some defaults from cookies *
\*************************************************************************/
2001-02-12 20:21:45 +01:00
function sessions()
{
global $phpgw, $phpgw_info, $sessionid, $kp3;
2001-02-07 14:07:09 +01:00
2001-02-12 20:21:45 +01:00
$this->db = $phpgw->db;
$this->db2 = $phpgw->db;
$this->sessionid = $sessionid;
$this->kp3 = $kp3;
}
/*************************************************************************\
* Functions for creating and verifying the session *
\*************************************************************************/
2001-02-12 20:21:45 +01:00
function getuser_ip()
{
global $REMOTE_ADDR, $HTTP_X_FORWARDED_FOR;
2001-02-12 20:21:45 +01:00
if ($HTTP_X_FORWARDED_FOR)
{
return $HTTP_X_FORWARDED_FOR;
}
else
{
return $REMOTE_ADDR;
}
}
function verify()
{
global $phpgw, $phpgw_info, $sessionid, $kp3;
$db = $phpgw->db;
$db2 = $phpgw->db;
$this->sessionid = $sessionid;
$this->kp3 = $kp3;
$phpgw->common->key = md5($this->kp3 . $this->sessionid . $phpgw_info['server']['encryptkey']);
$phpgw->common->iv = $phpgw_info['server']['mcrypt_iv'];
$cryptovars[0] = $phpgw->common->key;
$cryptovars[1] = $phpgw->common->iv;
$phpgw->crypto = CreateObject('phpgwapi.crypto', $cryptovars);
$db->query("select * from phpgw_sessions where session_id='" . $this->sessionid . "'",__LINE__,__FILE__);
$db->next_record();
$this->session_flags = $db->f('session_flags');
2001-02-12 20:21:45 +01:00
$login_array = explode('@', $db->f('session_lid'));
$this->account_lid = $login_array[0];
2001-06-17 18:55:04 +02:00
if (@$login_array[1] != '')
2001-02-12 20:21:45 +01:00
{
$this->account_domain = $login_array[1];
}
else
{
$this->account_domain = $phpgw_info['server']['default_domain'];
}
$phpgw_info['user']['kp3'] = $this->kp3;
$phpgw_info_flags = $phpgw_info['flags'];
$phpgw_info['flags'] = $phpgw_info_flags;
$userid_array = explode('@',$db->f('session_lid'));
2001-05-09 01:20:13 +02:00
// Thinking this might solve auth_http problems
2001-06-17 18:55:04 +02:00
if(@$userid_array[1] == '') { $userid_array[1] = 'default'; }
2001-02-12 20:21:45 +01:00
$this->account_lid = $userid_array[0];
$this->update_dla();
$this->account_id = $phpgw->accounts->name2id($this->account_lid);
if (! $this->account_id)
{
return False;
}
2001-03-21 07:00:06 +01:00
$phpgw_info['user']['account_id'] = $this->account_id;
$this->read_repositories($phpgw_info['server']['cache_phpgw_info']);
if ($this->user['expires'] != -1 && $this->user['expires'] < time())
2001-02-12 20:21:45 +01:00
{
return False;
2001-02-12 20:21:45 +01:00
}
2001-05-02 11:06:14 +02:00
$phpgw_info['user'] = $this->user;
$phpgw_info['hooks'] = $this->hooks;
2001-02-12 20:21:45 +01:00
$phpgw_info['user']['session_ip'] = $db->f('session_ip');
$phpgw_info['user']['passwd'] = base64_decode($this->appsession('password','phpgwapi'));
2001-02-12 20:21:45 +01:00
if ($userid_array[1] != $phpgw_info['user']['domain'])
{
return False;
}
if ($phpgw_info['server']['sessions_checkip'])
2001-02-12 20:21:45 +01:00
{
if (PHP_OS != 'Windows' && (! $phpgw_info['user']['session_ip'] || $phpgw_info['user']['session_ip'] != $this->getuser_ip()))
{
return False;
}
2001-02-12 20:21:45 +01:00
}
$phpgw->acl->acl($this->account_id);
$phpgw->accounts->accounts($this->account_id);
$phpgw->preferences->preferences($this->account_id);
$phpgw->applications->applications($this->account_id);
if (! $this->account_lid)
{
return False;
}
else
{
return True;
}
}
// This will remove stale sessions out of the database
function clean_sessions()
{
global $phpgw_info, $phpgw;
// If you plan on using the cron apps, please remove the following lines.
// I am going to make this a config option durring 0.9.11, instead of an application (jengo)
2001-06-04 03:07:23 +02:00
$phpgw->db->query("delete from phpgw_sessions where session_dla <= '" . (time() - 7200)
. "' and session_flags !='A'",__LINE__,__FILE__);
2001-06-04 03:07:23 +02:00
// This is set a little higher, we don't want to kill session data for anonymous sessions.
$phpgw->db->query("delete from phpgw_app_sessions where session_dla <= '" . (time() - 86400)
. "'",__LINE__,__FILE__);
2001-02-12 20:21:45 +01:00
}
function create($login,$passwd)
{
global $phpgw_info, $phpgw, $PHP_SELF;
2001-02-12 20:21:45 +01:00
$this->login = $login;
$this->passwd = $passwd;
2001-02-12 20:21:45 +01:00
$this->clean_sessions();
$login_array = explode('@', $login);
$this->account_lid = $login_array[0];
$now = time();
if ($login_array[1] != '')
{
$this->account_domain = $login_array[1];
}
else
{
$this->account_domain = $phpgw_info['server']['default_domain'];
}
if ($phpgw_info['server']['global_denied_users'][$this->account_lid])
{
return False;
}
if (! $phpgw->auth->authenticate($this->account_lid, $passwd))
{
return False;
exit;
}
if (!$phpgw->accounts->exists($this->account_lid) && $phpgw_info['server']['auto_create_acct'] == True)
{
$this->account_id = $phpgw->accounts->auto_add($this->account_lid, $passwd);
}
else
{
$this->account_id = $phpgw->accounts->name2id($this->account_lid);
}
2001-03-21 06:51:33 +01:00
$phpgw_info['user']['account_id'] = $this->account_id;
2001-03-21 07:05:44 +01:00
$phpgw->accounts->accounts($this->account_id);
2001-02-12 20:21:45 +01:00
$this->sessionid = md5($phpgw->common->randomstring(10));
$this->kp3 = md5($phpgw->common->randomstring(15));
$phpgw->common->key = md5($this->kp3 . $this->sessionid . $phpgw_info['server']['encryptkey']);
$phpgw->common->iv = $phpgw_info['server']['mcrypt_iv'];
$cryptovars[0] = $phpgw->common->key;
$cryptovars[1] = $phpgw->common->iv;
$phpgw->crypto = CreateObject('phpgwapi.crypto', $cryptovars);
if ($phpgw_info['server']['usecookies'])
{
Setcookie('sessionid',$this->sessionid);
Setcookie('kp3',$this->kp3);
Setcookie('domain',$this->account_domain);
Setcookie('last_domain',$this->account_domain,$now+1209600);
if ($this->account_domain == $phpgw_info['server']['default_domain'])
{
Setcookie('last_loginid', $this->account_lid ,$now+1209600); // For 2 weeks
}
else
{
Setcookie('last_loginid', $login ,$now+1209600); // For 2 weeks
}
unset ($phpgw_info['server']['default_domain']); // we kill this for security reasons
}
$this->read_repositories(False);
2001-05-02 11:06:14 +02:00
if ($this->user['expires'] != -1 && $this->user['expires'] < time())
{
return False;
}
2001-02-12 20:21:45 +01:00
$phpgw_info['user'] = $this->user;
$phpgw_info['hooks'] = $this->hooks;
$this->appsession('password','phpgwapi',base64_encode($this->passwd));
if ($phpgw->acl->check('anonymous',1,'phpgwapi'))
{
$session_flags = 'A';
}
else
{
$session_flags = 'N';
}
$user_ip = $this->getuser_ip();
2001-06-04 03:07:23 +02:00
$phpgw->db->transaction_begin();
2001-02-12 20:21:45 +01:00
$phpgw->db->query("insert into phpgw_sessions values ('" . $this->sessionid
. "','".$login."','" . $user_ip . "','"
. $now . "','" . $now . "','" . $PHP_SELF . "','" . $session_flags
. "')",__LINE__,__FILE__);
2001-02-12 20:21:45 +01:00
$phpgw->db->query("insert into phpgw_access_log values ('" . $this->sessionid . "','"
. "$login','" . $user_ip . "','$now','') ",__LINE__,__FILE__);
$this->appsession('account_previous_login','phpgwapi',$phpgw->auth->previous_login);
$phpgw->auth->update_lastlogin($this->account_id,$user_ip);
2001-06-04 03:07:23 +02:00
$phpgw->db->transaction_commit();
2001-02-12 20:21:45 +01:00
return $this->sessionid;
}
// This will update the DateLastActive column, so the login does not expire
function update_dla()
{
global $phpgw_info, $phpgw, $PHP_SELF, $menuaction;
if ($menuaction)
{
$action = $menuaction;
}
else
{
$action = $PHP_SELF;
}
$phpgw->db->query("update phpgw_sessions set session_dla='" . time() . "', session_action='$action' "
. "where session_id='" . $this->sessionid."'",__LINE__,__FILE__);
$phpgw->db->query("update phpgw_app_sessions set session_dla='" . time() . "' "
. "where sessionid='" . $this->sessionid."'",__LINE__,__FILE__);
2001-02-12 20:21:45 +01:00
}
2001-02-12 20:21:45 +01:00
function destroy()
{
global $phpgw, $phpgw_info, $sessionid, $kp3;
$phpgw_info['user']['sessionid'] = $sessionid;
$phpgw_info['user']['kp3'] = $kp3;
2001-06-04 03:07:23 +02:00
$phpgw->db->transaction_begin();
2001-02-12 20:21:45 +01:00
$phpgw->db->query("delete from phpgw_sessions where session_id='"
. $phpgw_info['user']['sessionid'] . "'",__LINE__,__FILE__);
$phpgw->db->query("delete from phpgw_app_sessions where sessionid='"
. $phpgw_info['user']['sessionid'] . "'",__LINE__,__FILE__);
$phpgw->db->query("update phpgw_access_log set lo='" . time() . "' where sessionid='"
. $phpgw_info['user']['sessionid'] . "'",__LINE__,__FILE__);
if ($phpgw_info['server']['usecookies'])
{
Setcookie('sessionid');
Setcookie('kp3');
if ($phpgw_info['multiable_domains'])
{
Setcookie('domain');
}
}
$this->clean_sessions();
2001-06-04 03:07:23 +02:00
$phpgw->db->transaction_commit();
2001-02-12 20:21:45 +01:00
return True;
}
/*************************************************************************\
* Functions for appsession data and session cache *
\*************************************************************************/
function read_repositories($cached='')
2001-02-12 20:21:45 +01:00
{
global $phpgw, $phpgw_info;
2001-02-12 20:21:45 +01:00
$phpgw->acl->acl($this->account_id);
$phpgw->accounts->accounts($this->account_id);
$phpgw->preferences->preferences($this->account_id);
$phpgw->applications->applications($this->account_id);
if(@$cached)
{
$this->user = $this->appsession('phpgw_info_cache','phpgwapi');
if(!empty($this->user))
{
$phpgw->preferences->data = $this->user['preferences'];
}
else
{
$this->setup_cache();
}
}
else
{
$this->setup_cache();
}
$this->hooks = $phpgw->hooks->read();
}
function setup_cache()
{
global $phpgw, $phpgw_info;
$this->user = $phpgw->accounts->read_repository();
2001-02-12 20:21:45 +01:00
$this->user['acl'] = $phpgw->acl->read_repository();
$this->user['preferences'] = $phpgw->preferences->read_repository();
$this->user['apps'] = $phpgw->applications->read_repository();
//@reset($this->data['user']['apps']);
2001-02-12 20:21:45 +01:00
$this->user['domain'] = $this->account_domain;
$this->user['sessionid'] = $this->sessionid;
$this->user['kp3'] = $this->kp3;
$this->user['session_ip'] = $this->getuser_ip();
$this->user['session_lid'] = $this->account_lid.'@'.$this->account_domain;
$this->user['account_id'] = $this->account_id;
$this->user['account_lid'] = $this->account_lid;
$this->user['userid'] = $this->account_lid;
2001-06-17 18:55:04 +02:00
$this->user['passwd'] = @$this->passwd;
if(@$phpgw_info['server']['cache_phpgw_info'])
{
$this->appsession('phpgw_info_cache','phpgwapi',$this->user);
}
2001-02-12 14:43:37 +01:00
}
2001-06-22 03:22:22 +02:00
function delete_cache($accountid='')
{
global $phpgw;
$account_id = get_account_id($accountid,$this->account_id);
$query = "DELETE FROM phpgw_app_sessions WHERE loginid = '".$account_id."'"
." AND app = 'phpgwapi' and location = 'phpgw_info_cache'";
$phpgw->db->query($query);
}
2001-02-12 20:21:45 +01:00
function save_repositories()
{
global $phpgw, $phpgw_info;
$phpgw_info_temp = $phpgw_info;
$phpgw_info_temp['user']['kp3'] = '';
$phpgw_info_temp['flags'] = array();
if ($phpgw_info['server']['cache_phpgw_info'])
{
$this->appsession('phpgw_info_cache','phpgwapi',$phpgw_info_temp);
}
2001-02-12 10:06:25 +01:00
}
2001-02-12 20:21:45 +01:00
function appsession($location = 'default', $appname = '', $data = '##NOTHING##')
{
global $phpgw_info, $phpgw;
2001-02-12 10:06:25 +01:00
2001-02-12 20:21:45 +01:00
if (! $appname)
{
$appname = $phpgw_info['flags']['currentapp'];
}
2001-02-12 10:06:25 +01:00
2001-02-12 20:21:45 +01:00
/* This allows the user to put "" as the value. */
if ($data == '##NOTHING##') {
$query = "select content from phpgw_app_sessions where"
." sessionid = '".$this->sessionid."' and loginid = '".$this->account_id."'"
." and app = '".$appname."' and location = '".$location."'";
2001-02-12 20:21:45 +01:00
$phpgw->db->query($query,__LINE__,__FILE__);
$phpgw->db->next_record();
// I added these into seperate steps for easier debugging
2001-02-12 20:21:45 +01:00
$data = $phpgw->db->f('content');
// Changed by Skeeter 2001 Mar 04 0400Z
// This was not properly decoding structures saved into session data properly
// $data = $phpgw->common->decrypt($data);
// return stripslashes($data);
return $phpgw->crypto->decrypt($data);
2001-02-12 10:06:25 +01:00
} else {
$phpgw->db->query("select content from phpgw_app_sessions where "
. "sessionid = '".$this->sessionid."' and loginid = '".$this->account_id."'"
. "and app = '".$appname."' and location = '".$location."'",__LINE__,__FILE__);
2001-02-12 20:21:45 +01:00
$encrypteddata = $phpgw->crypto->encrypt($data);
2001-02-12 20:21:45 +01:00
if ($phpgw->db->num_rows()==0) {
$phpgw->db->query("INSERT INTO phpgw_app_sessions (sessionid,loginid,app,location,content,session_dla) "
. "VALUES ('".$this->sessionid."','".$this->account_id."','".$appname
. "','".$location."','".$encrypteddata."','" . time() . "')",__LINE__,__FILE__);
2001-02-12 20:21:45 +01:00
} else {
$phpgw->db->query("update phpgw_app_sessions set content = '".$encrypteddata."'"
. "where sessionid = '".$this->sessionid."'"
. "and loginid = '".$this->account_id."' and app = '".$appname."'"
. "and location = '".$location."'",__LINE__,__FILE__);
2001-02-12 20:21:45 +01:00
}
return $data;
}
2001-02-12 10:06:25 +01:00
}
2001-02-12 20:21:45 +01:00
function restore()
{
2001-02-12 20:21:45 +01:00
global $phpgw;
$sessionData = $this->appsession("sessiondata");
2001-02-12 20:21:45 +01:00
if (is_array($sessionData))
{
2001-02-12 20:21:45 +01:00
reset($sessionData);
while(list($key,$value) = each($sessionData))
{
global $$key;
$$key = $value;
$this->variableNames[$key] = 'registered';
2001-04-16 19:45:19 +02:00
#print "restored: ".$key.", $value<br>";
2001-02-12 20:21:45 +01:00
}
}
}
2001-02-12 20:21:45 +01:00
// save the current values of the variables
function save()
{
global $phpgw;
if (is_array($this->variableNames))
{
reset($this->variableNames);
while(list($key, $value) = each($this->variableNames))
{
if ($value == 'registered')
{
global $$key;
$sessionData[$key] = $$key;
}
}
$this->appsession("sessiondata",'',$sessionData);
}
}
// create a list a variable names, wich data need's to be restored
function register($_variableName)
{
2001-02-11 16:16:49 +01:00
$this->variableNames[$_variableName]='registered';
#print 'registered '.$_variableName.'<br>';
}
2001-02-12 20:21:45 +01:00
// mark variable as unregistered
function unregister($_variableName)
{
2001-02-11 16:16:49 +01:00
$this->variableNames[$_variableName]='unregistered';
#print 'unregistered '.$_variableName.'<br>';
}
2001-02-12 20:21:45 +01:00
// check if we have a variable registred already
function is_registered($_variableName)
{
2001-02-11 16:16:49 +01:00
if ($this->variableNames[$_variableName] == 'registered')
{
return True;
}
else
{
return False;
}
}
/*************************************************************************\
* Function to handle session support via url or cookies *
\*************************************************************************/
function link($url, $extravars = '')
{
global $phpgw, $phpgw_info, $usercookie, $kp3, $PHP_SELF;
2001-02-12 20:21:45 +01:00
if (! $kp3)
{
$kp3 = $phpgw_info['user']['kp3'];
}
// Explicit hack to work around problems with php running as CGI on windows
// please let us know if this doesn't work for you!
// I am not sure how my changes will affect the following.
// Could someone with access to a Windows install check it ? (jengo)
/* if (! $url && (PHP_OS == 'Windows' || PHP_OS == 'OS/2' || PHP_OS == 'WIN32' || PHP_OS == 'WIN16'))
2001-02-12 20:21:45 +01:00
{
2001-02-11 16:16:49 +01:00
$exe = strpos($PHP_SELF,'php.exe');
if ($exe != false) {
2001-02-11 16:16:49 +01:00
$exe += 7; // strlen('php.exe')
$url_root = split ('/', $phpgw_info['server']['webserver_url']);
$url = (strlen($url_root[0])? $url_root[0].'//':'') . $url_root[2];
$url .= substr($PHP_SELF,$exe,strlen($PHP_SELF)-$exe);
}
}
*/
$url = $phpgw_info['server']['webserver_url'] . $url;
// This needs to be tested as well. (jengo)
/* if (! $url)
2001-02-12 20:21:45 +01:00
{
2001-02-11 16:16:49 +01:00
$url_root = split ('/', $phpgw_info['server']['webserver_url']);
// Some hosting providers have their paths screwy.
// If the value from $PHP_SELF is not what you expect, you can use this to patch it
// It will need to be adjusted to your specific problem tho.
//
2001-02-11 16:16:49 +01:00
//$patched_php_self = str_replace('/php4/php/phpgroupware', '/phpgroupware', $PHP_SELF);
$patched_php_self = $PHP_SELF;
$url = (strlen($url_root[0])? $url_root[0].'//':'') . $url_root[2] . $patched_php_self;
}
*/
2001-02-12 20:21:45 +01:00
if (isset($phpgw_info['server']['usecookies']) && $phpgw_info['server']['usecookies'])
{
if ($extravars)
{
$url .= '?' . $extravars;
}
}
else
{
2001-06-17 18:55:04 +02:00
$url .= '?sessionid=' . @$phpgw_info['user']['sessionid'];
2001-02-12 20:21:45 +01:00
$url .= '&kp3=' . $kp3;
2001-06-17 18:55:04 +02:00
$url .= '&domain=' . @$phpgw_info['user']['domain'];
// This doesn't belong in the API.
// Its up to the app to pass this value. (jengo)
// Putting it into the app requires a massive number of updates in email app.
// Until that happens this needs to stay here (seek3r)
2001-05-13 06:08:01 +02:00
if (isset($phpgw_info['flags']['newsmode']) &&
$phpgw_info['flags']['newsmode'])
2001-02-12 20:21:45 +01:00
{
$url .= '&newsmode=on';
}
2001-02-12 20:21:45 +01:00
if ($extravars)
{
$url .= '&' . $extravars;
2001-02-12 20:21:45 +01:00
}
}
/* $url = str_replace('/?', '/index.php?', $url);
2001-02-11 16:16:49 +01:00
$webserver_url_count = strlen($phpgw_info['server']['webserver_url']);
$slash_check = strtolower(substr($url ,0,1));
2001-02-12 20:21:45 +01:00
if (substr($url ,0,$webserver_url_count) != $phpgw_info['server']['webserver_url'])
{
2001-02-11 16:16:49 +01:00
$app = $phpgw_info['flags']['currentapp'];
2001-02-12 20:21:45 +01:00
if ($slash_check == '/')
{
$url = $phpgw_info['server']['webserver_url'] . $url;
}
elseif ($app == 'home' || $app == 'logout' || $app == 'login')
{
2001-02-11 16:16:49 +01:00
$url = $phpgw_info['server']['webserver_url'].'/'.$url;
2001-02-12 20:21:45 +01:00
}
else
{
2001-02-11 16:16:49 +01:00
$url = $phpgw_info['server']['webserver_url'].'/'.$app.'/'.$url;
}
} */
//echo "$url\n";
return $url;
}
2001-02-12 20:21:45 +01:00
}
2001-02-07 23:25:57 +01:00
?>