head	1.2;
access;
symbols;
locks; strict;
comment	@# @;


1.2
date	2006.06.25.16.26.33;	author TWikiContributor;	state Exp;
branches;
next	1.1;

1.1
date	2006.02.01.12.01.25;	author TWikiContributor;	state Exp;
branches;
next	;


desc
@new-topic
@


1.2
log
@buildrelease
@
text
@---+ Package =TWiki::Client=

The package is also a Factory for login managers and also the base class
for all login managers.

On it's own, an object of this class is used when you specify 'none' in
the security setup section of
[[%SCRIPTURL%/configure%SCRIPTSUFFIX%][configure]]. When it is used,
logins are not supported. If you want to authenticate users then you should
consider TemplateLogin or ApacheLogin, which are subclasses of this class.

If you are building a new login manager, then you should write a new subclass
of this class, implementing the methods marked as *VIRTUAL*. There are already
examples in the =lib/TWiki/Client= directory.

The class has extensive tracing, which is enabled by
$TWiki::cfg{Trace}{Client.pm}. The tracing is done in such a way as to
let the perl optimiser optimise out the trace function as a no-op if tracing
is disabled.

---++ ObjectData =twiki=
The TWiki object this login manager is attached to.


%TOC%

---++ StaticMethod *makeClient* <tt>($twiki) -> $TWiki::Client</tt>
Factory method, used to generate a new TWiki::Client object
for the given session.



---++ ObjectMethod *loadSession* <tt>()</tt>

Get the client session data, using the cookie and/or the request URL.
Set up appropriate session variables in the twiki object and return
the login name.



---++ ObjectMethod *checkAccess* <tt>()</tt>
Check if the script being run in this session is authorised for execution.
If not, throw an access control exception.



---++ ObjectMethod *finish* <tt></tt>
Complete processing after the client's HTTP request has been responded
to. Flush the user's session (if any) to disk.



---++ StaticMethod *expireDeadSessions* <tt>()</tt>
Delete sessions that are sitting around but are really expired.
This *assumes* that the sessions are stored as files.

This is a static method, but requires TWiki::cfg. It is designed to be
run from a session or from a cron job.



---++ ObjectMethod *userLoggedIn* <tt>($login,$wikiname)</tt>

Called when the user logs in. It's invoked from TWiki::UI::Register::finish
for instance, when the user follows the link in their verification email
message.
   * =$login= - string login name
   * =$wikiname= - string wikiname



---++ ObjectMethod *endRenderingHandler* <tt>()</tt>
This handler is called by getRenderedVersion just before the plugins
postRenderingHandler. So it is passed all HTML text just before it is
printed.

*DEPRECATED* Use postRenderingHandler instead.



---++ ObjectMethod *addCookie* <tt>($c)</tt>

Add a cookie to the list of cookies for this session.
   * =$c= - a CGI::Cookie



---++ ObjectMethod *modifyHeader* <tt>(\%header)</tt>
Modify a HTTP header
   * =\%header= - header entries



---++ ObjectMethod *redirectCgiQuery* <tt>($url)</tt>
Generate an HTTP redirect on STDOUT, if you can. Return 1 if you did.
Don't forget to pass all query parameters through.
   * =$url= - target of the redirection.



---++ ObjectMethod *getSessionValues* <tt>() -> \%values</tt>
Get a name->value hash of all the defined session variables



---++ ObjectMethod *getSessionValue* <tt>($name) -> $value</tt>
Get the value of a session variable.



---++ ObjectMethod *setSessionValue* <tt>($name,$value)</tt>
Set the value of a session variable.
We do not allow setting of AUTHUSER.



---++ ObjectMethod *clearSessionValue* <tt>($name)</tt>
Clear the value of a session variable.
We do not allow setting of AUTHUSER.



---++ ObjectMethod *forceAuthentication* <tt>() -> boolean</tt>

*VIRTUAL METHOD* implemented by subclasses

Triggered by an access control violation, this method tests
to see if the current session is authenticated or not. If not,
it does whatever is needed so that the user can log in, and returns 1.

If the user has an existing authenticated session, the function simply drops
though and returns 0.



---++ ObjectMethod *loginUrl* <tt>(...) -> $url</tt>

*VIRTUAL METHOD* implemented by subclasses

Return a full URL suitable for logging in.
   * =...= - url parameters to be added to the URL, in the format required by TWiki::getScriptUrl()



---++ ObjectMethod *getUser* <tt>()</tt>

*VIRTUAL METHOD* implemented by subclasses

If there is some other means of getting a username - for example,
Apache has remote_user() - then return it. Otherwise, return undef and
the username stored in the session will be used.


@


1.1
log
@buildrelease
@
text
@d16 8
@
