[ Index ]
 

Code source de eGroupWare 1.2.106-2

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/phpgwapi/inc/ -> class.sessions.inc.php (sommaire)

(pas de description)

Poids: 1365 lignes (43 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

sessions_:: (34 méthodes):
  sessions_()
  commit_session()
  split_login_domain()
  verify()
  getuser_ip()
  phpgw_set_cookiedomain()
  phpgw_setcookie()
  create()
  log_access()
  login_blocked()
  verify_server()
  create_server()
  read_repositories()
  setup_cache()
  save_repositories()
  restore()
  save()
  register()
  unregister()
  is_registered()
  generate_click_history()
  is_repost()
  link()
  read_session()
  clean_sessions()
  set_cookie_params()
  new_session_id()
  register_session()
  update_dla()
  destroy()
  delete_cache()
  appsession()
  list_sessions()
  total()


Classe: sessions_  - X-Ref

Session Management Libabray

This allows eGroupWare to use php4 or database sessions

sessions_($domain_names=null)   X-Ref
Constructor just loads up some defaults from cookies


commit_session()   X-Ref
commit the sessiondata to storage (needs to be reimplemented for the subclasses)

return: bool

split_login_domain($both,&$login,&$domain)   X-Ref
Pas de description

verify($sessionid='',$kp3='')   X-Ref
Check to see if a session is still current and valid

param: string $sessionid session id to be verfied
param: string $kp3 ?? to be verified
return: bool is the session valid?

getuser_ip()   X-Ref
Get the ip address of current users

return: string ip address

phpgw_set_cookiedomain()   X-Ref
Set the domain used for cookies

return: string domain

phpgw_setcookie($cookiename,$cookievalue='',$cookietime=0)   X-Ref
Set a cookie

param: string $cookiename name of cookie to be set
param: string $cookievalue value to be used, if unset cookie is cleared (optional)
param: int $cookietime when cookie should expire, 0 for session only (optional)

create($login,$passwd = '',$passwd_type = '')   X-Ref
Create a new session

param: string $login user login
param: string $passwd user password
param: string $passwd_type type of password being used, ie plaintext, md5, sha1
return: string session id

log_access($sessionid,$login='',$user_ip='',$account_id='')   X-Ref
Write or update (for logout) the access_log

param: string $sessionid id of session or 0 for unsuccessful logins
param: string $login account_lid (evtl. with domain) or '' for settion the logout-time
param: string $user_ip ip to log
param: int $account_id numerical account_id

login_blocked($login,$ip)   X-Ref
Protect against brute force attacks, block login if too many unsuccessful login attmepts

returns: bool login blocked?
param: string $login account_lid (evtl. with domain)
param: string $ip ip of the user

verify_server($sessionid, $kp3)   X-Ref
Verfy a peer server access request

param: string $sessionid session id to verfiy
param: string $kp3 ??
return: bool verfied?

create_server($login,$passwd)   X-Ref
Validate a peer server login request

param: string $login login name
param: string $password password
return: bool login ok?

read_repositories($cached='',$write_cache=True)   X-Ref
Is this also useless?? (skwashd)


setup_cache($write_cache=True)   X-Ref
Is this also useless?? (skwashd)


save_repositories()   X-Ref
This looks to be useless
This will capture everything in the $GLOBALS['egw_info'] including server info,
and store it in appsessions.  This is really incompatible with any type of restoring
from appsession as the saved user info is really in ['user'] rather than the root of
the structure, which is what this class likes.


restore()   X-Ref
Pas de description

save()   X-Ref
Save the current values of all registered variables


register($_variableName)   X-Ref
Create a list a variable names, which data needs to be restored

param: string $_variableName name of variable to be registered

unregister($_variableName)   X-Ref
Mark variable as unregistered

param: string $_variableName name of variable to deregister

is_registered($_variableName)   X-Ref
Check if we have a variable registred already

param: string $_variableName name of variable to check
return: bool was the variable found?

generate_click_history()   X-Ref
Additional tracking of user actions - prevents reposts/use of back button

author: skwashd
return: string current history id

is_repost($display_error = False)   X-Ref
Detects if the page has already been called before - good for forms

author: skwashd
param: bool $diplay_error when implemented will use the generic error handling code
return: True if called previously, else False - call ok

link($url, $extravars = '')   X-Ref
Generate a url which supports url or cookies based sessions

Please note, the values of the query get url encoded!

param: string $url a url relative to the egroupware install root, it can contain a query too
param: array/string $extravars query string arguements as string or array (prefered)
return: string generated url

read_session()   X-Ref
Load user's session information

The sessionid of the session to read is passed in the class-var $this->sessionid

return: mixed the session data

clean_sessions()   X-Ref
Remove stale sessions out of the database


set_cookie_params($domain)   X-Ref
Set paramaters for cookies - only implemented in PHP4 sessions

param: string $domain domain name to use in cookie

new_session_id()   X-Ref
Create a new session id

return: string a new session id

register_session($login,$user_ip,$now,$session_flags)   X-Ref
Create a new session

param: string $login user login
param: string $user_ip users ip address
param: int $now time now as a unix timestamp
param: string $session_flags A = Anonymous, N = Normal

update_dla()   X-Ref
Update the date last active info for the session, so the login does not expire

return: bool did it suceed?

destroy($sessionid, $kp3)   X-Ref
Terminate a session

param: string $sessionid the id of the session to be terminated
param: string $kp3 - NOT SURE
return: bool did it suceed?

delete_cache($accountid='')   X-Ref
Delete all data from the session cache for a user

param: int $accountid user account id, defaults to current user (optional)

appsession($location = 'default', $appname = '', $data = ')   X-Ref
Stores or retrieves information from the sessions cache

param: string $location identifier for data
param: string $appname name of app which is responsbile for the data
param: mixed $data data to be stored, if left blank data is retreived (optional)
return: mixed data from cache, only returned if $data arg is not used

list_sessions($start,$order,$sort,$all_no_sort = False)   X-Ref
Get list of normal / non-anonymous sessions
Note: The data from the session-files get cached in the app_session phpgwapi/php4_session_cache

author: ralfbecker
param: int $start session to start at
param: string $order field to sort on
param: string $sort sort order
param: bool $all_no_sort list all with out sorting (optional) default False
return: array info for all current sessions

total()   X-Ref
Get the number of normal / non-anonymous sessions

author: ralfbecker
return: int number of sessions



Généré le : Sun Feb 25 17:20:01 2007 par Balluche grâce à PHPXref 0.7