source: branches/2.0/phpgwapi/inc/class.sessions.inc.php @ 2850

Revision 2850, 42.5 KB checked in by niltonneto, 11 years ago (diff)

Ticket #1041 - Corrigido problema na validação da sessão por IP.

  • Property svn:eol-style set to native
  • Property svn:executable set to *
Line 
1<?php
2  /**************************************************************************\
3  * eGroupWare API - Session management                                      *
4  * This file written by Dan Kuykendall <seek3r@phpgroupware.org>            *
5  * and Joseph Engo <jengo@phpgroupware.org>                                 *
6  * and Ralf Becker <ralfbecker@outdoor-training.de>                         *
7  * Copyright (C) 2000, 2001 Dan Kuykendall                                  *
8  * Parts Copyright (C) 2003 Free Software Foundation Inc                    *
9  * -------------------------------------------------------------------------*
10  * This library is part of the eGroupWare API                               *
11  * http://www.egroupware.org/api                                            * 
12  * ------------------------------------------------------------------------ *
13  * This library is free software; you can redistribute it and/or modify it  *
14  * under the terms of the GNU Lesser General Public License as published by *
15  * the Free Software Foundation; either version 2.1 of the License,         *
16  * or any later version.                                                    *
17  * This library is distributed in the hope that it will be useful, but      *
18  * WITHOUT ANY WARRANTY; without even the implied warranty of               *
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
20  * See the GNU Lesser General Public License for more details.              *
21  * You should have received a copy of the GNU Lesser General Public License *
22  * along with this library; if not, write to the Free Software Foundation,  *
23  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA            *
24  \**************************************************************************/
25
26
27        /* sessions_type setup moved after the class below - milosch */
28
29        /**
30        * Session Management Libabray
31        *
32        * This allows eGroupWare to use php4 or database sessions
33        *
34        * @package phpgwapi
35        * @subpackage sessions
36        * @abstract
37        * @author NetUSE AG Boris Erdmann, Kristian Koehntopp <br> hacked on by phpGW
38        * @copyright &copy; 1998-2000 NetUSE AG Boris Erdmann, Kristian Koehntopp <br> &copy; 2003 FreeSoftware Foundation
39        * @license LGPL
40        * @link http://www.sanisoft.com/phplib/manual/DB_sql.php
41        * @uses db
42        */
43
44        class sessions_
45        {
46                /**
47                * @var string current user login
48                */
49                var $login;
50
51                /**
52                * @var string current user password
53                */
54                var $passwd;
55
56                /**
57                * @var int current user db/ldap account id
58                */
59                var $account_id;
60
61                /**
62                * @var string current user account login id - ie user@domain
63                */
64                var $account_lid;
65
66                /**
67                * @var string previous page call id - repost prevention
68                */
69                var $history_id;
70
71                /**
72                * @var string domain for current user
73                */
74                var $account_domain;
75
76                /**
77                * @var session type flag, A - anonymous session, N - None, normal session
78                */
79                var $session_flags;
80
81                /**
82                * @var string current user session id
83                */
84                var $sessionid;
85
86                /**
87                * @var string not sure what this does, but it is important :)
88                */
89                var $kp3;
90
91                /**
92                * @var string encryption key?
93                */
94                var $key;
95
96                /**
97                * @var string iv == ivegotnoidea ;) (skwashd)
98                */
99                var $iv;
100
101                /**
102                * @var session data
103                */
104                var $data;
105       
106                /**
107                * @var object holder for the database object
108                */
109                var $db;
110       
111                /**
112                * @var array publicly available methods
113                */
114                var $public_functions = array(
115                        'list_methods' => True,
116                        'update_dla'   => True,
117                        'list'         => True,
118                        'total'        => True
119                );
120
121                /**
122                * @var string domain for cookies
123                */
124                var $cookie_domain;
125
126                /**
127                * @var name of XML-RPC/SOAP method called
128                */
129                var $xmlrpc_method_called;
130
131                /**
132                * Constructor just loads up some defaults from cookies
133                */
134                function sessions_()
135                {
136                        $this->db = $GLOBALS['phpgw']->db;
137                        $this->sessionid = get_var('sessionid',array('GET','COOKIE'));
138                        $this->kp3       = get_var('kp3',array('GET','COOKIE'));
139                        /* Create the crypto object */
140                        $GLOBALS['phpgw']->crypto = CreateObject('phpgwapi.crypto');
141                        if ($GLOBALS['phpgw_info']['server']['usecookies'])
142                        {
143                                $this->phpgw_set_cookiedomain();
144                        }
145                        // verfiy and if necessary create and save our config settings
146                        //
147                        $save_rep = False;
148                        if (!isset($GLOBALS['phpgw_info']['server']['max_access_log_age']))
149                        {
150                                $GLOBALS['phpgw_info']['server']['max_access_log_age'] = 90;    // default 90 days
151                                $save_rep = True;
152                        }
153                        if (!isset($GLOBALS['phpgw_info']['server']['block_time']))
154                        {
155                                $GLOBALS['phpgw_info']['server']['block_time'] = 30;    // default 30min
156                                $save_rep = True;
157                        }
158                        if (!isset($GLOBALS['phpgw_info']['server']['num_unsuccessful_id']))
159                        {
160                                $GLOBALS['phpgw_info']['server']['num_unsuccessful_id']  = 3;   // default 3 trys per id
161                                $save_rep = True;
162                        }
163                        if (!isset($GLOBALS['phpgw_info']['server']['num_unsuccessful_ip']))
164                        {
165                                $GLOBALS['phpgw_info']['server']['num_unsuccessful_ip']  = $GLOBALS['phpgw_info']['server']['num_unsuccessful_id'];     // default same as for id
166                                $save_rep = True;
167                        }
168                        if (!isset($GLOBALS['phpgw_info']['server']['install_id']))
169                        {
170                                $GLOBALS['phpgw_info']['server']['install_id']  = md5($GLOBALS['phpgw']->common->randomstring(15));
171                                $save_rep = True;
172                        }
173                        if (!isset($GLOBALS['phpgw_info']['server']['sessions_timeout']))
174                        {
175                                $GLOBALS['phpgw_info']['server']['sessions_timeout'] = 14400;
176                                $save_rep = True;
177                        }
178                        if (!isset($GLOBALS['phpgw_info']['server']['sessions_app_timeout']))
179                        {
180                                $GLOBALS['phpgw_info']['server']['sessions_app_timeout'] = 86400;
181                                $save_rep = True;
182                        }
183                        if (!isset($GLOBALS['phpgw_info']['server']['max_history']))
184                        {
185                                $GLOBALS['phpgw_info']['server']['max_history'] = 20;
186                                $save_rep = True;
187                        }
188                       
189                        // jakjr: ? usando o hardcode, para evitar sempre 2 chamadas ao banco.
190                        /*
191                        if ($save_rep)
192                        {
193                                $config = CreateObject('phpgwapi.config','phpgwapi');
194                                $config->read_repository();
195                                $config->value('max_access_log_age',$GLOBALS['phpgw_info']['server']['max_access_log_age']);
196                                $config->value('block_time',$GLOBALS['phpgw_info']['server']['block_time']);
197                                $config->value('num_unsuccessful_id',$GLOBALS['phpgw_info']['server']['num_unsuccessful_id']);
198                                $config->value('num_unsuccessful_ip',$GLOBALS['phpgw_info']['server']['num_unsuccessful_ip']);
199                                $config->value('install_id',$GLOBALS['phpgw_info']['server']['install_id']);
200                                $config->value('sessions_timeout',$GLOBALS['phpgw_info']['server']['sessions_timeout']);
201                                $config->value('sessions_app_timeout',$GLOBALS['phpgw_info']['server']['sessions_app_timeout']);
202                                $config->save_repository();
203                                unset($config);
204                        }*/
205                }
206
207                /**
208                * Introspection for XML-RPC/SOAP
209                * Diabled - why??
210                *
211                * @param string $_type tpye of introspection being sought
212                * @return array available methods and args
213                */
214                function DONTlist_methods($_type)
215                {
216                        if (is_array($_type))
217                        {
218                                $_type = $_type['type'];
219                        }
220
221                        switch($_type)
222                        {
223                                case 'xmlrpc':
224                                        $xml_functions = array(
225                                                'list_methods' => array(
226                                                        'function'  => 'list_methods',
227                                                        'signature' => array(array(xmlrpcStruct,xmlrpcString)),
228                                                        'docstring' => lang('Read this list of methods.')
229                                                ),
230                                                'update_dla' => array(
231                                                        'function'  => 'update_dla',
232                                                        'signature' => array(array(xmlrpcBoolean)),
233                                                        'docstring' => lang('Returns an array of todo items')
234                                                )
235                                        );
236                                        return $xml_functions;
237                                        break;
238                                case 'soap':
239                                        return $this->soap_functions;
240                                        break;
241                                default:
242                                        return array();
243                                        break;
244                        }
245                }
246
247                function split_login_domain($both,&$login,&$domain)
248                {
249                        $parts = explode('@',$both);
250                        $domain = count($parts) > 1 ? array_pop($parts) :
251                                $GLOBALS['phpgw_info']['server']['default_domain'];
252                        $login = implode('@',$parts);
253                }
254
255                /**
256                * Check to see if a session is still current and valid
257                *
258                * @param string $sessionid session id to be verfied
259                * @param string $kp3 ?? to be verified
260                * @return bool is the session valid?
261                */
262                function verify($sessionid='',$kp3='')
263                {
264                        if(empty($sessionid) || !$sessionid)
265                        {
266                                $sessionid = get_var('sessionid',array('GET','COOKIE'));
267                                $kp3       = get_var('kp3',array('GET','COOKIE'));
268                        }
269
270                        $this->sessionid = $sessionid;
271                        $this->kp3       = $kp3;
272
273                        $session = $this->read_session();
274                        //echo "<pre>session::verify(id='$sessionid'): \n".print_r($session,True)."</pre>\n";
275                        /*
276                        $fp = fopen('/tmp/session_verify','a+');
277                        fwrite($fp,"session::verify(id='$sessionid'): \n".print_r($session,True)."\n\n");
278                        fclose($fp);
279                        */
280                        if ($session['session_dla'] <= (time() - $GLOBALS['phpgw_info']['server']['sessions_timeout']))
281                        {
282                                $this->destroy($sessionid,$kp3);
283                                return False;
284                        }
285
286                        $this->session_flags = $session['session_flags'];
287
288                        sessions_::split_login_domain($session['session_lid'],$this->account_lid,$this->account_domain);
289
290                        $GLOBALS['phpgw_info']['user']['kp3'] = $this->kp3;
291
292                        $this->update_dla();
293                        $this->account_id = $GLOBALS['phpgw']->accounts->name2id($this->account_lid);
294                        if (!$this->account_id)
295                        {
296                                return False;
297                        }
298
299                        $GLOBALS['phpgw_info']['user']['account_id'] = $this->account_id;
300
301                        /* init the crypto object before appsession call below */
302                        $this->key = md5($this->kp3 . $this->sessionid . @$GLOBALS['phpgw_info']['server']['encryptkey']);
303                        $this->iv  = $GLOBALS['phpgw_info']['server']['mcrypt_iv'];
304                        $GLOBALS['phpgw']->crypto->init(array($this->key,$this->iv));
305
306                        $this->read_repositories(@$GLOBALS['phpgw_info']['server']['cache_phpgw_info']);
307                       
308                        if ($this->user['expires'] != -1 && $this->user['expires'] < time())
309                        {
310                                if(is_object($GLOBALS['phpgw']->log))
311                                {
312                                        $GLOBALS['phpgw']->log->message(array(
313                                                'text' => 'W-VerifySession, account loginid %1 is expired',
314                                                'p1'   => $this->account_lid,
315                                                'line' => __LINE__,
316                                                'file' => __FILE__
317                                        ));
318                                        $GLOBALS['phpgw']->log->commit();
319                                }
320                                return False;
321                        }
322
323                        $GLOBALS['phpgw_info']['user']  = $this->user;
324                        $GLOBALS['phpgw_info']['hooks'] = $this->hooks;
325
326                        $GLOBALS['phpgw_info']['user']['session_ip'] = $session['session_ip'];
327                        $GLOBALS['phpgw_info']['user']['passwd']     = base64_decode($this->appsession('password','phpgwapi'));
328
329                        if ($this->account_domain != $GLOBALS['phpgw_info']['user']['domain'])
330                        {
331                                if(is_object($GLOBALS['phpgw']->log))
332                                {
333                                        $GLOBALS['phpgw']->log->message(array(
334                                                'text' => 'W-VerifySession, the domains %1 and %2 don\'t match',
335                                                'p1'   => $userid_array[1],
336                                                'p2'   => $GLOBALS['phpgw_info']['user']['domain'],
337                                                'line' => __LINE__,
338                                                'file' => __FILE__
339                                        ));
340                                        $GLOBALS['phpgw']->log->commit();
341                                }
342                                return False;
343                        }
344
345                        /* ExpressoLivre
346                           Necessário comentar para que o redirecionamento de uma sessão
347                           https para uma http funcionasse atrás de um proxy
348                        */
349
350                        /*
351                        if (@$GLOBALS['phpgw_info']['server']['sessions_checkip'])
352                        {
353                                if((PHP_OS != 'Windows') && (PHP_OS != 'WINNT') &&
354                                        (!$GLOBALS['phpgw_info']['user']['session_ip'] || $GLOBALS['phpgw_info']['user']['session_ip'] != $this->getuser_ip())
355                                )
356                                {
357                                        //echo "IP do cliente com https   ---->  ".$GLOBALS['phpgw_info']['user']['session_ip'];
358                                        //echo "<BR>IP do cliente com http ---->  ".$this->getuser_ip();
359                                        if(is_object($GLOBALS['phpgw']->log))
360                                        {
361                                                // This needs some better wording
362                                                $GLOBALS['phpgw']->log->message(array(
363                                                        'text' => 'W-VerifySession, IP %1 doesn\'t match IP %2 in session table',
364                                                        'p1'   => $this->getuser_ip(),
365                                                        'p2'   => $GLOBALS['phpgw_info']['user']['session_ip'],
366                                                        'line' => __LINE__,
367                                                        'file' => __FILE__
368                                                ));
369                                                $GLOBALS['phpgw']->log->commit();
370                                        }
371                                        return False;
372                                }
373                        }
374                        */
375
376                        $GLOBALS['phpgw']->acl->acl($this->account_id);
377                        $GLOBALS['phpgw']->accounts->accounts($this->account_id);
378                        $GLOBALS['phpgw']->preferences->preferences($this->account_id);
379                        $GLOBALS['phpgw']->applications->applications($this->account_id);
380
381                        if (! $this->account_lid)
382                        {
383                                if(is_object($GLOBALS['phpgw']->log))
384                                {
385                                        // This needs some better wording
386                                        $GLOBALS['phpgw']->log->message(array(
387                                                'text' => 'W-VerifySession, account_id is empty',
388                                                'line' => __LINE__,
389                                                'file' => __FILE__
390                                        ));
391                                        $GLOBALS['phpgw']->log->commit();
392                                }
393                                //echo 'DEBUG: Sessions: account_id is empty!<br>'."\n";
394                                return False;
395                        }
396                        return True;
397                }
398
399                /**
400                * Functions for creating and verifying the session
401                */
402       
403                /**
404                * Get the ip address of current users
405                *
406                * @return string HTTP_X_FORWARDED_FOR (if exists) and REMOTE_ADDR ip addresses.
407                */
408                function getuser_ip()
409                {
410                        return (isset($_SERVER['HTTP_X_FORWARDED_FOR']) ? $_SERVER['HTTP_X_FORWARDED_FOR']."," : "").$_SERVER['REMOTE_ADDR'];
411                }
412
413                /**
414                * Set the domain used for cookies
415                *
416                * @return string domain
417                */
418                function phpgw_set_cookiedomain()
419                {
420                        // Use HTTP_X_FORWARDED_HOST if set, which is the case behind a none-transparent proxy
421                        $this->cookie_domain = isset($_SERVER['HTTP_X_FORWARDED_HOST']) ?  $_SERVER['HTTP_X_FORWARDED_HOST'] : $_SERVER['HTTP_HOST'];
422
423                        // remove port from HTTP_HOST
424                        if (preg_match("/^(.*):(.*)$/",$this->cookie_domain,$arr))
425                        {
426                                $this->cookie_domain = $arr[1];
427                        }
428                        if (count(explode('.',$this->cookie_domain)) <= 1)
429                        {
430                                // setcookie dont likes domains without dots, leaving it empty, gets setcookie to fill the domain in
431                                $this->cookie_domain = '';
432                        }
433                        print_debug('COOKIE_DOMAIN',$this->cookie_domain,'api');
434
435                        $this->set_cookie_params($this->cookie_domain); // for php4 sessions necessary
436                }
437
438                /**
439                * Set a cookie
440                *
441                * @param string $cookiename name of cookie to be set
442                * @param string $cookievalue value to be used, if unset cookie is cleared (optional)
443                * @param int $cookietime when cookie should expire, 0 for session only (optional)
444                */
445                function phpgw_setcookie($cookiename,$cookievalue='',$cookietime=0)
446                {
447                        if (!$this->cookie_domain)
448                        {
449                                $this->phpgw_set_cookiedomain();
450                        }
451                        setcookie($cookiename,$cookievalue,$cookietime,'/',$this->cookie_domain,null,true);
452                }
453
454                /**
455                * Create a new session
456                *
457                * @param string $login user login
458                * @param string $passwd user password
459                * @param string $passwd_type type of password being used, ie plaintext, md5, sha1
460                * @return string session id
461                */
462                function create($login,$passwd = '',$passwd_type = '')
463                {
464                        if (is_array($login))
465                        {
466                                $this->login       = $login['login'];
467                                $this->passwd      = $login['passwd'];
468                                $this->passwd_type = $login['passwd_type'];
469                                $login             = $this->login;
470                        }
471                        else
472                        {
473                                $this->login       = $login;
474                                $this->passwd      = $passwd;
475                                $this->passwd_type = $passwd_type;
476                        }
477
478                        $this->clean_sessions();
479                        //sessions_::split_login_domain($login,$this->account_lid,$this->account_domain);
480                        // jakjr: allow uid with (@);
481                        $this->account_lid = $login;
482                        $this->account_domain = 'default';
483
484                        $now = time();
485
486                        //echo "<p>session::create(login='$login'): lid='$this->account_lid', domain='$this->account_domain'</p>\n";
487                        $user_ip = $this->getuser_ip();
488                               
489                        $this->account_id = $GLOBALS['phpgw']->accounts->name2id($this->account_lid);
490
491                        if (($blocked = $this->login_blocked($login,$user_ip)) ||       // too many unsuccessful attempts
492                                $GLOBALS['phpgw_info']['server']['global_denied_users'][$this->account_lid] ||
493                                !$GLOBALS['phpgw']->auth->authenticate($this->account_lid, $this->passwd, $this->passwd_type) ||
494                                $this->account_id && $GLOBALS['phpgw']->accounts->get_type($this->account_id) == 'g')
495                        {
496                                $this->reason = $blocked ? 'blocked, too many attempts' : 'bad login or password';
497                                $this->cd_reason = $blocked ? 99 : 5;
498
499                                $this->log_access($this->reason,$login,$user_ip,0);     // log unsuccessfull login
500                                return False;
501                        }
502                        // Só verifica tempo de inatividade do usuário, caso esteja configurado no Administrador.
503                        if(isset($GLOBALS['phpgw_info']['server']['time_to_account_expires']) &&
504                                $this->account_id !=null && $this->account_lid != "expresso-admin") {
505                                        $last_access = $this->get_last_access_on_history($this->account_id);
506                                        $this->read_repositories(False);
507                                        if ($last_access && ($last_access+($GLOBALS['phpgw_info']['server']['time_to_account_expires']*86400) < time()))
508                                        {
509                                                if(is_object($GLOBALS['phpgw']->log))
510                                                {
511                                                        $GLOBALS['phpgw']->log->message(array(
512                                                                'text' => 'W-LoginFailure, account loginid %1 is expired for innativity',
513                                                                'p1'   => $this->account_lid,
514                                                                'line' => __LINE__,
515                                                                'file' => __FILE__
516                                                        ));
517                                                        $GLOBALS['phpgw']->log->commit();
518                                                }
519                                                $this->reason = 'account is expired';
520                                                $this->cd_reason = 98;
521               
522                                                return False;
523                                        }
524                        }
525
526                        /* jakjr: Expresso does not use auto-create account.
527                        if (!$this->account_id && $GLOBALS['phpgw_info']['server']['auto_create_acct'] == True)
528                        {
529                                $this->account_id = $GLOBALS['phpgw']->accounts->auto_add($this->account_lid, $passwd);
530                        }
531                        */
532
533                        $GLOBALS['phpgw_info']['user']['account_id'] = $this->account_id;
534                        $GLOBALS['phpgw']->accounts->accounts($this->account_id);
535                        $this->sessionid = $this->new_session_id();
536                        $this->kp3       = md5($GLOBALS['phpgw']->common->randomstring(15));
537
538                        if ($GLOBALS['phpgw_info']['server']['usecookies'])
539                        {
540                                $this->phpgw_setcookie('sessionid',$this->sessionid);
541                                $this->phpgw_setcookie('kp3',$this->kp3);
542                                $this->phpgw_setcookie('domain',$this->account_domain);
543                        }
544                        if ($GLOBALS['phpgw_info']['server']['usecookies'] || isset($_COOKIE['last_loginid']))
545                        {
546                                $this->phpgw_setcookie('last_loginid', $this->account_lid ,$now+1209600); /* For 2 weeks */
547                                $this->phpgw_setcookie('last_domain',$this->account_domain,$now+1209600);
548                                $this->phpgw_setcookie('last_organization',$_POST['organization'],$now+1209600);
549                        }
550                        unset($GLOBALS['phpgw_info']['server']['default_domain']); /* we kill this for security reasons */
551
552                        /* init the crypto object */
553                        $this->key = md5($this->kp3 . $this->sessionid . $GLOBALS['phpgw_info']['server']['encryptkey']);
554                        $this->iv  = $GLOBALS['phpgw_info']['server']['mcrypt_iv'];
555                        $GLOBALS['phpgw']->crypto->init(array($this->key,$this->iv));
556
557                        $this->read_repositories(False);
558                        if ($this->user['expires'] != -1 && $this->user['expires'] < time())
559                        {
560                                if(is_object($GLOBALS['phpgw']->log))
561                                {
562                                        $GLOBALS['phpgw']->log->message(array(
563                                                'text' => 'W-LoginFailure, account loginid %1 is expired',
564                                                'p1'   => $this->account_lid,
565                                                'line' => __LINE__,
566                                                'file' => __FILE__
567                                        ));
568                                        $GLOBALS['phpgw']->log->commit();
569                                }
570                                $this->reason = 'account is expired';
571                                $this->cd_reason = 98;
572
573                                return False;
574                        }
575
576                        $GLOBALS['phpgw_info']['user']  = $this->user;
577                        $GLOBALS['phpgw_info']['hooks'] = $this->hooks;
578
579                        $this->appsession('password','phpgwapi',base64_encode($this->passwd));
580                        if ($GLOBALS['phpgw']->acl->check('anonymous',1,'phpgwapi'))
581                        {
582                                $session_flags = 'A';
583                        }
584                        else
585                        {
586                                $session_flags = 'N';
587                        }
588
589                        $GLOBALS['phpgw']->db->transaction_begin();
590                        $this->register_session($login,$user_ip,$now,$session_flags);
591                        if ($session_flags != 'A')              // dont log anonymous sessions
592                        {
593                                $this->log_access($this->sessionid,$login,$user_ip,$this->account_id);
594                        }
595                        $this->appsession('account_previous_login','phpgwapi',$GLOBALS['phpgw']->auth->previous_login);
596                        // Expresso
597                        //$GLOBALS['phpgw']->auth->update_lastlogin($this->account_id,$user_ip);
598                        $GLOBALS['phpgw']->db->transaction_commit();
599
600                        //if (!$this->sessionid) echo "<p>session::create(login='$login') = '$this->sessionid': lid='$this->account_lid', domain='$this->account_domain'</p>\n";
601
602                        return $this->sessionid;
603                }
604
605                /**
606                 * Retorna o UNIX DATE do ultimo acesso dessa conta, baseado na tabela de histórico.
607                 */
608                function get_last_access_on_history($account_id) {
609                        $GLOBALS['phpgw']->db->query("select li from phpgw_access_log where account_id='$account_id' order by li desc limit 1",__LINE__,__FILE__);
610                        if(!$GLOBALS['phpgw']->db->next_record())
611                                return false;
612                        return $GLOBALS['phpgw']->db->f('li');
613                }
614
615                /**
616        * Write or update (for logout) the access_log
617                *
618                * @param string $sessionid id of session or 0 for unsuccessful logins
619                * @param string $login account_lid (evtl. with domain) or '' for settion the logout-time
620                * @param string $user_ip ip to log
621                * @param int $account_id numerical account_id
622                */
623                function log_access($sessionid,$login='',$user_ip='',$account_id='')
624                {
625                        $now = time();
626
627                        if ($login != '')
628                        {
629                                if (strlen($login) > 30)
630                                {
631                                        $login = substr($login,0,30);
632                                }
633                                $GLOBALS['phpgw']->db->query('INSERT INTO phpgw_access_log(sessionid,loginid,ip,li,lo,account_id,browser)'
634                                        . " VALUES ('" . $sessionid . "','" . $this->db->db_addslashes($login). "','"
635                                        . $this->db->db_addslashes($user_ip) . "',$now,0," . (int)$account_id .",'".$this->db->db_addslashes(substr($_SERVER[ 'HTTP_USER_AGENT' ],0,199))."')",__LINE__,__FILE__);
636                        }
637                        else if($sessionid != 'bad login or password')
638                        {
639                                $GLOBALS['phpgw']->db->query("UPDATE phpgw_access_log SET lo=" . $now . " WHERE sessionid='"
640                                        . $sessionid . "'",__LINE__,__FILE__);
641                        }
642
643                        /* jakjr: Clean phpgw_access_log with a crontab event.
644                        if ($GLOBALS['phpgw_info']['server']['max_access_log_age'])
645                        {
646                                $max_age = $now - $GLOBALS['phpgw_info']['server']['max_access_log_age'] * 24 * 60 * 60;
647
648                                $GLOBALS['phpgw']->db->query("DELETE FROM phpgw_access_log WHERE li < $max_age");
649                        }
650                        */
651                }
652
653                /**
654                * Protect against brute force attacks, block login if too many unsuccessful login attmepts
655        *
656                * @param string $login account_lid (evtl. with domain)
657                * @param string $ip ip of the user
658                * @returns bool login blocked?
659                */
660                function login_blocked($login,$ip)
661                {
662                        /*jakjr: Disable this protection. When block an proxy server ip, all the sub-network will be blocking.*/
663                        return false;
664
665                        $blocked = False;
666                        $block_time = time() - $GLOBALS['phpgw_info']['server']['block_time'] * 60;
667                       
668                        $ip = $this->db->db_addslashes($ip);
669                        $this->db->query("SELECT count(*) FROM phpgw_access_log WHERE account_id=0 AND ip='$ip' AND li > $block_time",__LINE__,__FILE__);
670                        $this->db->next_record();
671                        if (($false_ip = $this->db->f(0)) > $GLOBALS['phpgw_info']['server']['num_unsuccessful_ip'])
672                        {
673                                //echo "<p>login_blocked: ip='$ip' ".$this->db->f(0)." trys (".$GLOBALS['phpgw_info']['server']['num_unsuccessful_ip']." max.) since ".date('Y/m/d H:i',$block_time)."</p>\n";
674                                $blocked = True;
675                        }
676                       
677                        $login = $this->db->db_addslashes($login);
678                        $this->db->query("SELECT count(*) FROM phpgw_access_log WHERE account_id=0 AND (loginid='$login' OR loginid LIKE '$login@%') AND li > $block_time",__LINE__,__FILE__);
679                        $this->db->next_record();
680                        if (($false_id = $this->db->f(0)) > $GLOBALS['phpgw_info']['server']['num_unsuccessful_id'])
681                        {
682                                //echo "<p>login_blocked: login='$login' ".$this->db->f(0)." trys (".$GLOBALS['phpgw_info']['server']['num_unsuccessful_id']." max.) since ".date('Y/m/d H:i',$block_time)."</p>\n";
683                                $blocked = True;
684                        }
685                        if ($blocked && $GLOBALS['phpgw_info']['server']['admin_mails'] &&
686                                // max. one mail each 5mins
687                                $GLOBALS['phpgw_info']['server']['login_blocked_mail_time'] < time()-5*60)
688                        {
689                                // notify admin(s) via email
690                                $from    = 'eGroupWare@'.$GLOBALS['phpgw_info']['server']['mail_suffix'];
691                                $subject = lang("eGroupWare: login blocked for user '%1', IP %2",$login,$ip);
692                                $body    = lang("Too many unsucessful attempts to login: %1 for the user '%2', %3 for the IP %4",$false_id,$login,$false_ip,$ip);
693                               
694                                if(!is_object($GLOBALS['phpgw']->send))
695                                {
696                                        $GLOBALS['phpgw']->send = CreateObject('phpgwapi.send');
697                                }
698                                $subject = $GLOBALS['phpgw']->send->encode_subject($subject);
699                                $admin_mails = explode(',',$GLOBALS['phpgw_info']['server']['admin_mails']);
700                                foreach($admin_mails as $to)
701                                {
702                                        $GLOBALS['phpgw']->send->msg('email',$to,$subject,$body,'','','',$from,$from);
703                                }
704                                // save time of mail, to not send to many mails
705                                $config = CreateObject('phpgwapi.config','phpgwapi');
706                                $config->read_repository();
707                                $config->value('login_blocked_mail_time',time());
708                                $config->save_repository();
709                        }
710                        return $blocked;
711                }
712
713                /**
714                * Verfy a peer server access request
715                *
716                * @param string $sessionid session id to verfiy
717                * @param string $kp3 ??
718                * @return bool verfied?
719                */
720                function verify_server($sessionid, $kp3)
721                {
722                        $GLOBALS['phpgw']->interserver = CreateObject('phpgwapi.interserver');
723                        $this->sessionid = $sessionid;
724                        $this->kp3       = $kp3;
725
726                        $session = $this->read_session();
727                        $this->session_flags = $session['session_flags'];
728
729                        list($this->account_lid,$this->account_domain) = explode('@', $session['session_lid']);
730                       
731                        if ($this->account_domain == '')
732                        {
733                                $this->account_domain = $GLOBALS['phpgw_info']['server']['default_domain'];
734                        }
735
736                        $GLOBALS['phpgw_info']['user']['kp3'] = $this->kp3;
737                        $phpgw_info_flags = $GLOBALS['phpgw_info']['flags'];
738
739                        $GLOBALS['phpgw_info']['flags'] = $phpgw_info_flags;
740
741                        $this->update_dla();
742                        $this->account_id = $GLOBALS['phpgw']->interserver->name2id($this->account_lid);
743
744                        if (!$this->account_id)
745                        {
746                                return False;
747                        }
748
749                        $GLOBALS['phpgw_info']['user']['account_id'] = $this->account_id;
750
751                        $this->read_repositories(@$GLOBALS['phpgw_info']['server']['cache_phpgw_info']);
752
753                        /* init the crypto object before appsession call below */
754                        $this->key = md5($this->kp3 . $this->sessionid . $GLOBALS['phpgw_info']['server']['encryptkey']);
755                        $this->iv  = $GLOBALS['phpgw_info']['server']['mcrypt_iv'];
756                        $GLOBALS['phpgw']->crypto->init(array($this->key,$this->iv));
757
758                        $GLOBALS['phpgw_info']['user']  = $this->user;
759                        $GLOBALS['phpgw_info']['hooks'] = $this->hooks;
760
761                        $GLOBALS['phpgw_info']['user']['session_ip'] = $session['session_ip'];
762                        $GLOBALS['phpgw_info']['user']['passwd'] = base64_decode($this->appsession('password','phpgwapi'));
763
764                        if ($userid_array[1] != $GLOBALS['phpgw_info']['user']['domain'])
765                        {
766                                if(is_object($GLOBALS['phpgw']->log))
767                                {
768                                        $GLOBALS['phpgw']->log->message(array(
769                                                'text' => 'W-VerifySession, the domains %1 and %2 don\t match',
770                                                'p1'   => $userid_array[1],
771                                                'p2'   => $GLOBALS['phpgw_info']['user']['domain'],
772                                                'line' => __LINE__,
773                                                'file' => __FILE__
774                                        ));
775                                        $GLOBALS['phpgw']->log->commit();
776                                }
777
778                                if(is_object($GLOBALS['phpgw']->crypto))
779                                {
780                                        $GLOBALS['phpgw']->crypto->cleanup();
781                                        unset($GLOBALS['phpgw']->crypto);
782                                }
783                                return False;
784                        }
785
786                        if(@$GLOBALS['phpgw_info']['server']['sessions_checkip'])
787                        {
788                                if((PHP_OS != 'Windows') && (PHP_OS != 'WINNT') &&
789                                        (!$GLOBALS['phpgw_info']['user']['session_ip'] || $GLOBALS['phpgw_info']['user']['session_ip'] != $this->getuser_ip())
790                                )
791                                {
792                                        if(is_object($GLOBALS['phpgw']->log))
793                                        {
794                                                // This needs some better wording
795                                                $GLOBALS['phpgw']->log->message(array(
796                                                        'text' => 'W-VerifySession, IP %1 doesn\'t match IP %2 in session table',
797                                                        'p1'   => $this->getuser_ip(),
798                                                        'p2'   => $GLOBALS['phpgw_info']['user']['session_ip'],
799                                                        'line' => __LINE__,
800                                                        'file' => __FILE__
801                                                ));
802                                                $GLOBALS['phpgw']->log->commit();
803                                        }
804
805                                        if(is_object($GLOBALS['phpgw']->crypto))
806                                        {
807                                                $GLOBALS['phpgw']->crypto->cleanup();
808                                                unset($GLOBALS['phpgw']->crypto);
809                                        }
810                                        return False;
811                                }
812                        }
813
814                        $GLOBALS['phpgw']->acl->acl($this->account_id);
815                        $GLOBALS['phpgw']->accounts->accounts($this->account_id);
816                        $GLOBALS['phpgw']->preferences->preferences($this->account_id);
817                        $GLOBALS['phpgw']->applications->applications($this->account_id);
818
819                        if (! $this->account_lid)
820                        {
821                                if(is_object($GLOBALS['phpgw']->log))
822                                {
823                                        // This needs some better wording
824                                        $GLOBALS['phpgw']->log->message(array(
825                                                'text' => 'W-VerifySession, account_id is empty',
826                                                'line' => __LINE__,
827                                                'file' => __FILE__
828                                        ));
829                                        $GLOBALS['phpgw']->log->commit();
830                                }
831
832                                if(is_object($GLOBALS['phpgw']->crypto))
833                                {
834                                        $GLOBALS['phpgw']->crypto->cleanup();
835                                        unset($GLOBALS['phpgw']->crypto);
836                                }
837                                return False;
838                        }
839                        else
840                        {
841                                return True;
842                        }
843                }
844
845                /**
846                * Validate a peer server login request
847                *
848                * @param string $login login name
849                * @param string $password password
850                * @return bool login ok?
851                */
852                function create_server($login,$passwd)
853                {
854                        $GLOBALS['phpgw']->interserver = CreateObject('phpgwapi.interserver');
855                        $this->login  = $login;
856                        $this->passwd = $passwd;
857                        $this->clean_sessions();
858                        $login_array = explode('@', $login);
859                        $this->account_lid = $login_array[0];
860                        $now = time();
861
862                        if ($login_array[1] != '')
863                        {
864                                $this->account_domain = $login_array[1];
865                        }
866                        else
867                        {
868                                $this->account_domain = $GLOBALS['phpgw_info']['server']['default_domain'];
869                        }
870
871                        $serverdata = array(
872                                'server_name' => $this->account_domain,
873                                'username'    => $this->account_lid,
874                                'password'    => $passwd
875                        );
876                        if (!$GLOBALS['phpgw']->interserver->auth($serverdata))
877                        {
878                                return False;
879                                exit;
880                        }
881
882                        if (!$GLOBALS['phpgw']->interserver->exists($this->account_lid))
883                        {
884                                $this->account_id = $GLOBALS['phpgw']->interserver->name2id($this->account_lid);
885                        }
886                        $GLOBALS['phpgw_info']['user']['account_id'] = $this->account_id;
887                        $GLOBALS['phpgw']->interserver->serverid = $this->account_id;
888
889                        $this->sessionid = md5($GLOBALS['phpgw']->common->randomstring(10));
890                        $this->kp3       = md5($GLOBALS['phpgw']->common->randomstring(15));
891
892                        /* re-init the crypto object */
893                        $this->key = md5($this->kp3 . $this->sessionid . $GLOBALS['phpgw_info']['server']['encryptkey']);
894                        $this->iv  = $GLOBALS['phpgw_info']['server']['mcrypt_iv'];
895                        $GLOBALS['phpgw']->crypto->init(array($this->key,$this->iv));
896
897                        //$this->read_repositories(False);
898
899                        $GLOBALS['phpgw_info']['user']  = $this->user;
900                        $GLOBALS['phpgw_info']['hooks'] = $this->hooks;
901
902                        $this->appsession('password','phpgwapi',base64_encode($this->passwd));
903                        $session_flags = 'S';
904
905                        $user_ip = $this->getuser_ip();
906
907                        $GLOBALS['phpgw']->db->transaction_begin();
908                        $this->register_session($login,$user_ip,$now,$session_flags);
909
910                        $this->log_access($this->sessionid,$login,$user_ip,$this->account_id);
911
912                        $this->appsession('account_previous_login','phpgwapi',$GLOBALS['phpgw']->auth->previous_login);
913                        $GLOBALS['phpgw']->auth->update_lastlogin($this->account_id,$user_ip);
914                        $GLOBALS['phpgw']->db->transaction_commit();
915
916                        return array($this->sessionid,$this->kp3);
917                }
918
919                /**
920                * Functions for appsession data and session cache
921                */
922
923                /**
924                * Is this also useless?? (skwashd)
925                */
926                function read_repositories($cached='',$write_cache=True)
927                {
928                        $GLOBALS['phpgw']->acl->acl($this->account_id);
929                        $GLOBALS['phpgw']->accounts->accounts($this->account_id);
930                        $GLOBALS['phpgw']->preferences->preferences($this->account_id);
931                        $GLOBALS['phpgw']->applications->applications($this->account_id);
932
933                        if(@$cached)
934                        {
935                                $this->user = $this->appsession('phpgw_info_cache','phpgwapi');
936                                if(!empty($this->user))
937                                {
938                                        $GLOBALS['phpgw']->preferences->data = $this->user['preferences'];
939                                        if (!isset($GLOBALS['phpgw_info']['apps']) || !is_array($GLOBALS['phpgw_info']['apps']))
940                                        {
941                                                $GLOBALS['phpgw']->applications->read_installed_apps();
942                                        }
943                                }
944                                else
945                                {
946                                        $this->setup_cache($write_cache);
947                                }
948                        }
949                        else
950                        {
951                                $this->setup_cache($write_cache);
952                        }
953                        $this->hooks = $GLOBALS['phpgw']->hooks->read();
954                }
955
956                /**
957                * Is this also useless?? (skwashd)
958                */
959                function setup_cache($write_cache=True)
960                {
961                        $this->user                = $GLOBALS['phpgw']->accounts->read_repository();
962                        $this->user['acl']         = $GLOBALS['phpgw']->acl->read_repository();
963                        $this->user['preferences'] = $GLOBALS['phpgw']->preferences->read_repository();
964                        $this->user['apps']        = $GLOBALS['phpgw']->applications->read_repository();
965                        //@reset($this->data['user']['apps']);
966
967                        $this->user['domain']      = $this->account_domain;
968                        $this->user['sessionid']   = $this->sessionid;
969                        $this->user['kp3']         = $this->kp3;
970                        $this->user['session_ip']  = $this->getuser_ip();
971                        $this->user['session_lid'] = $this->account_lid.'@'.$this->account_domain;
972                        $this->user['account_id']  = $this->account_id;
973                        $this->user['account_lid'] = $this->account_lid;
974                        $this->user['userid']      = $this->account_lid;
975                        $this->user['passwd']      = @$this->passwd;
976                        if(@$GLOBALS['phpgw_info']['server']['cache_phpgw_info'] && $write_cache)
977                        {
978                                $this->delete_cache();
979                                $this->appsession('phpgw_info_cache','phpgwapi',$this->user);
980                        }
981                }
982       
983                /**
984                * This looks to be useless
985                * This will capture everything in the $GLOBALS['phpgw_info'] including server info,
986                * and store it in appsessions.  This is really incompatible with any type of restoring
987                * from appsession as the saved user info is really in ['user'] rather than the root of
988                * the structure, which is what this class likes.
989                */
990                function save_repositories()
991                {
992                        $phpgw_info_temp = $GLOBALS['phpgw_info'];
993                        $phpgw_info_temp['user']['kp3'] = '';
994                        $phpgw_info_temp['flags'] = array();
995
996                        if ($GLOBALS['phpgw_info']['server']['cache_phpgw_info'])
997                        {
998                                $this->appsession('phpgw_info_cache','phpgwapi',$phpgw_info_temp);
999                        }
1000                }
1001
1002                function restore()
1003                {
1004                        $sessionData = $this->appsession('sessiondata');
1005
1006                        if (!empty($sessionData) && is_array($sessionData))
1007                        {
1008                                foreach($sessionData as $key => $value)
1009                                {
1010                                        global $$key;
1011                                        $$key = $value;
1012                                        $this->variableNames[$key] = 'registered';
1013                                        // echo 'restored: '.$key.', ' . $value . '<br>';
1014                                }
1015                        }
1016                }
1017
1018                /**
1019                * Save the current values of all registered variables
1020                */
1021                function save()
1022                {
1023                        if (is_array($this->variableNames))
1024                        {
1025                                reset($this->variableNames);
1026                                while(list($key, $value) = each($this->variableNames))
1027                                {
1028                                        if ($value == 'registered')
1029                                        {
1030                                                global $$key;
1031                                                $sessionData[$key] = $$key;
1032                                        }
1033                                }
1034                                $this->appsession('sessiondata','',$sessionData);
1035                        }
1036                }
1037
1038                /**
1039                * Create a list a variable names, which data needs to be restored
1040                *
1041                * @param string $_variableName name of variable to be registered
1042                */
1043                function register($_variableName)
1044                {
1045                        $this->variableNames[$_variableName]='registered';
1046                        #print 'registered '.$_variableName.'<br>';
1047                }
1048
1049                /**
1050                * Mark variable as unregistered
1051                *
1052                * @param string $_variableName name of variable to deregister
1053                */
1054                function unregister($_variableName)
1055                {
1056                        $this->variableNames[$_variableName]='unregistered';
1057                        #print 'unregistered '.$_variableName.'<br>';
1058                }
1059
1060                /**
1061                * Check if we have a variable registred already
1062                *
1063                * @param string $_variableName name of variable to check
1064                * @return bool was the variable found?
1065                */
1066                function is_registered($_variableName)
1067                {
1068                        if ($this->variableNames[$_variableName] == 'registered')
1069                        {
1070                                return True;
1071                        }
1072                        else
1073                        {
1074                                return False;
1075                        }
1076                }
1077                /**
1078                * Additional tracking of user actions - prevents reposts/use of back button
1079                *
1080                * @author skwashd
1081                * @return string current history id
1082                */
1083                function generate_click_history()
1084                {
1085                        if(!isset($this->history_id))
1086                        {
1087                                $this->history_id = md5($this->login . time());
1088                                $history = $this->appsession($location = 'history', $appname = 'phpgwapi');
1089                               
1090                                if(count($history) >= $GLOBALS['phpgw_info']['server']['max_history'])
1091                                {
1092                                        array_shift($history);
1093                                        $this->appsession($location = 'history', $appname = 'phpgwapi', $history);
1094                                }
1095                        }
1096                        return $this->history_id;
1097                }
1098               
1099                /**
1100                * Detects if the page has already been called before - good for forms
1101                *
1102                * @author skwashd
1103                * @param bool $diplay_error when implemented will use the generic error handling code
1104                * @return True if called previously, else False - call ok
1105                */
1106                function is_repost($display_error = False)
1107                {
1108                        $history = $this->appsession($location = 'history', $appname = 'phpgwapi');
1109                        if(isset($history[$_GET['click_history']]))
1110                        {
1111                                if($display_error)
1112                                {
1113                                        $GLOBALS['phpgw']->redirect_link('/error.php', 'type=repost');//more on this later :)
1114                                }
1115                                else
1116                                {
1117                                        return True; //handled by the app
1118                                }
1119                        }
1120                        else
1121                        {
1122                                $history[$_GET['click_history']] = True;
1123                                $this->appsession($location = 'history', $appname = 'phpgwapi', $history);
1124                                return False;
1125                        }
1126                }
1127
1128                /**
1129                * Generate a url which supports url or cookies based sessions
1130                *
1131                * @param string $url a url relative to the egroupware install root
1132                * @param array $extravars query string arguements
1133                * @return string generated url
1134                */
1135                function link($url, $extravars = '')
1136                {
1137                        //echo "<p>session::link(url='".print_r($url,True)."',extravars='".print_r($extravars,True)."')";
1138                        /* first we process the $url to build the full scriptname */
1139                        $full_scriptname = True;
1140
1141                        $url_firstchar = substr($url ,0,1);
1142                        if ($url_firstchar == '/' && $GLOBALS['phpgw_info']['server']['webserver_url'] == '/')
1143                        {
1144                                $full_scriptname = False;
1145                        }
1146
1147                        if ($url_firstchar != '/')
1148                        {
1149                                $app = $GLOBALS['phpgw_info']['flags']['currentapp'];
1150                                if ($app != 'home' && $app != 'login' && $app != 'logout')
1151                                {
1152                                        $url = $app.'/'.$url;
1153                                }
1154                        }
1155
1156                        if($full_scriptname)
1157                        {
1158                                $webserver_url_count = strlen($GLOBALS['phpgw_info']['server']['webserver_url'])-1;
1159                                if(substr($GLOBALS['phpgw_info']['server']['webserver_url'] ,$webserver_url_count,1) != '/' && $url_firstchar != '/')
1160                                {
1161                                        $url = $GLOBALS['phpgw_info']['server']['webserver_url'] .'/'. $url;
1162                                }
1163                                else
1164                                {
1165                                        $url = $GLOBALS['phpgw_info']['server']['webserver_url'] . $url;
1166                                }
1167                        }
1168
1169                        if(@isset($GLOBALS['phpgw_info']['server']['enforce_ssl']) && $GLOBALS['phpgw_info']['server']['enforce_ssl']) // && !$_SERVER['HTTPS']) imho https should always be a full path - skwashd
1170                        {
1171                                if(substr($url ,0,4) != 'http')
1172                                {
1173                                        $url = 'https://'.$GLOBALS['phpgw_info']['server']['hostname'].$url;
1174                                }
1175                                else
1176                                {
1177                                        $url = str_replace ( 'http:', 'https:', $url);
1178                                }
1179                        }
1180
1181                        /* Now we process the extravars into a proper url format */
1182                        /* if its not an array, then we turn it into one */
1183                        /* We do this to help prevent any duplicates from being sent. */
1184                        if (!is_array($extravars) && $extravars != '')
1185                        {
1186                                $new_extravars = Array();
1187
1188                                $a = explode('&', $extravars);
1189                                $i = 0;
1190                                while ($i < count($a))
1191                                {
1192                                        $b = split('=', $a[$i],2);
1193                                        // Check if this value doesn't already exist in new_extravars
1194                                        if(array_key_exists($b[0], $new_extravars))
1195                                        {
1196                                                // print "Debug::Error !!! " . $b[0] . " ($i) already exists<br>";
1197                                                if( eregi("\[\]", $b[0]) )
1198                                                {
1199                                                        $b[0] = eregi_replace("\[\]", "[$i]", $b[0]);
1200                                                }
1201                                        }
1202
1203                                        $new_extravars[$b[0]] = $b[1];
1204                                        $i++;
1205                                }
1206                                $extravars = $new_extravars;
1207                                unset($new_extravars);
1208                        }
1209
1210                        /* if using frames we make sure there is a framepart */
1211                        if(@defined('PHPGW_USE_FRAMES') && PHPGW_USE_FRAMES)
1212                        {
1213                                if (!isset($extravars['framepart']))
1214                                {
1215                                        $extravars['framepart']='body';
1216                                }
1217                        }
1218
1219                        /* add session params if not using cookies */
1220                        if (@!$GLOBALS['phpgw_info']['server']['usecookies'])
1221                        {
1222                                $extravars['sessionid'] = $this->sessionid;
1223                                $extravars['kp3'] = $this->kp3;
1224                                $extravars['domain'] = $this->account_domain;
1225                        }
1226
1227                        //used for repost prevention
1228//                      $extravars['click_history'] = $this->generate_click_history();
1229
1230                        /* if we end up with any extravars then we generate the url friendly string */
1231                        if (is_array($extravars))
1232                        {
1233                                $new_extravars = '';
1234                                foreach($extravars as $key => $value)
1235                                {
1236                                        if (!empty($new_extravars))
1237                                        {
1238                                                $new_extravars .= '&';
1239                                        }
1240                                        $new_extravars .= $key.'='.urlencode($value);
1241                                }
1242                                $url .= '?' . $new_extravars;
1243                        }
1244                        //echo " = '$url'</p>\n";
1245                        return $url;
1246                }
1247
1248                /**
1249                * The remaining methods are abstract - as they are unique for each session handler
1250                */
1251
1252                /**
1253                * Load user's session information
1254                *
1255                * The sessionid of the session to read is passed in the class-var $this->sessionid
1256                *
1257                * @return mixed the session data
1258                */
1259                function read_session()
1260                {}
1261
1262                /**
1263                * Remove stale sessions out of the database
1264                */
1265                function clean_sessions()
1266                {}
1267
1268                /**
1269                * Set paramaters for cookies - only implemented in PHP4 sessions
1270                *
1271                * @param string $domain domain name to use in cookie
1272                */
1273
1274                function set_cookie_params($domain)
1275                {}
1276
1277                /**
1278                * Create a new session id
1279                *
1280                * @return string a new session id
1281                */
1282                function new_session_id()
1283                {}
1284
1285                /**
1286                * Create a new session
1287                *
1288                * @param string $login user login
1289                * @param string $user_ip users ip address
1290                * @param int $now time now as a unix timestamp
1291                * @param string $session_flags A = Anonymous, N = Normal
1292                */
1293                function register_session($login,$user_ip,$now,$session_flags)
1294                {}
1295
1296                /**
1297                * Update the date last active info for the session, so the login does not expire
1298                *
1299                * @return bool did it suceed?
1300                */
1301                function update_dla()
1302                {}
1303
1304                /**
1305                * Terminate a session
1306                *
1307                * @param string $sessionid the id of the session to be terminated
1308                * @param string $kp3 - NOT SURE
1309                * @return bool did it suceed?
1310                */
1311                function destroy($sessionid, $kp3)
1312                {}
1313
1314                /**
1315                * Functions for appsession data and session cache
1316                */
1317       
1318                /**
1319                * Delete all data from the session cache for a user
1320                *
1321                * @param int $accountid user account id, defaults to current user (optional)
1322                */
1323                function delete_cache($accountid='')
1324                {}
1325
1326                /**
1327                * Stores or retrieves information from the sessions cache
1328                *
1329                * @param string $location identifier for data
1330                * @param string $appname name of app which is responsbile for the data
1331                * @param mixed $data data to be stored, if left blank data is retreived (optional)
1332                * @return mixed data from cache, only returned if $data arg is not used
1333                */
1334                function appsession($location = 'default', $appname = '', $data = '##NOTHING##')
1335                {}
1336
1337                /**
1338                * Get list of normal / non-anonymous sessions
1339                * Note: The data from the session-files get cached in the app_session phpgwapi/php4_session_cache
1340                *
1341                * @author ralfbecker
1342                * @param int $start session to start at
1343                * @param string $order field to sort on
1344                * @param string $sort sort order
1345                * @param bool $all_no_sort list all with out sorting (optional) default False
1346                * @return array info for all current sessions
1347                */
1348                function list_sessions($start,$order,$sort,$all_no_sort = False)
1349                {}
1350               
1351                /**
1352                * Get the number of normal / non-anonymous sessions
1353                *
1354                * @author ralfbecker
1355                * @return int number of sessions
1356                */
1357                function total()
1358                {}
1359        }
1360
1361        if(empty($GLOBALS['phpgw_info']['server']['sessions_type']))
1362        {
1363                $GLOBALS['phpgw_info']['server']['sessions_type'] = 'php4';     // the more performant default
1364        }
1365        // for php4 sessions, check if the extension is loaded, try loading it and fallback to db sessions if not
1366        if ($GLOBALS['phpgw_info']['server']['sessions_type'] == 'php4' && !extension_loaded('session'))
1367        {
1368                // some constanst for pre php4.3
1369                if (!defined('PHP_SHLIB_SUFFIX'))
1370                {
1371                        define('PHP_SHLIB_SUFFIX',strtoupper(substr(PHP_OS, 0,3)) == 'WIN' ? 'dll' : 'so');
1372                }
1373                if (!defined('PHP_SHLIB_PREFIX'))
1374                {
1375                        define('PHP_SHLIB_PREFIX',PHP_SHLIB_SUFFIX == 'dll' ? 'php_' : '');
1376                }
1377                if (!function_exists('dl') || !@dl(PHP_SHLIB_PREFIX.'session'.'.'.PHP_SHLIB_SUFFIX))
1378                {
1379                        $GLOBALS['phpgw_info']['server']['sessions_type'] = 'db';       // fallback if we have no php4 sessions support
1380                }
1381        }
1382        include_once(PHPGW_API_INC.'/class.sessions_'.$GLOBALS['phpgw_info']['server']['sessions_type'].'.inc.php');
Note: See TracBrowser for help on using the repository browser.