buildrelease

[openafs-wiki.git] / TWiki / CGISessionDotPm.mdwn

# <a name="Package &lt;code&gt;="></a> Package =

**extends** `CGI::Session::ErrorHandler `

<div>
  <ul>
    <li><a href="#Package =="> Package ==</a></li>
  </ul>
</div>

=head1 NAME

CGI::Session - persistent session data in CGI applications

=head1 SYNOPSIS

# Object initialization: use CGI::Session; $session = new CGI::Session();

$CGISESSID = $session-&gt;id();

# send proper HTTP header with cookies: print $session-&gt;header();

# storing data in the session $session-&gt;param('f\_name', 'Sherzod'); # or $session-&gt;param(-name=&gt;'l\_name', -value=&gt;'Ruzmetov');

# flush the data from memory to the storage driver at least before your # program finishes since auto-flushing can be unreliable $session-&gt;flush();

# retrieving data my $f\_name = $session-&gt;param('f\_name'); # or my $l\_name = $session-&gt;param(-name=&gt;'l\_name');

# clearing a certain session parameter $session-&gt;clear(["l\_name", "f\_name"]);

# expire '\_is\_logged\_in' flag after 10 idle minutes: $session-&gt;expire('is\_logged\_in', '+10m')

# expire the session itself after 1 idle hour $session-&gt;expire('+1h');

# delete the session for good $session-&gt;delete();

=head1 DESCRIPTION

CGI-Session is a Perl5 library that provides an easy, reliable and modular session management system across HTTP requests. Persistency is a key feature for such applications as shopping carts, login/authentication routines, and application that need to carry data across HTTP requests. CGI::Session does that and many more.

=head1 TRANSLATIONS

This document is also available in Japanese.

=over 4

=item o

Translation based on 4.14: <http://digit.que.ne.jp/work/index.cgi?Perldoc/ja>

=item o

Translation based on 3.11, including Cookbook and Tutorial: <http://perldoc.jp/docs/modules/CGI-Session-3.11/>

=back

=head1 TO LEARN MORE

Current manual is optimized to be used as a quick reference. To learn more both about the philosophy and CGI::Session programming style, consider the following:

=over 4

=item \*

L&lt;CGI::Session::Tutorial|CGI::Session::Tutorial&gt; - extended CGI::Session manual. Also includes library architecture and driver specifications.

=item \*

We also provide mailing lists for CGI::Session users. To subscribe to the list or browse the archives visit <https://lists.sourceforge.net/lists/listinfo/cgi-session-user>

=item \*

B - "HTTP State Management Mechanism" found at <ftp://ftp.isi.edu/in-notes/rfc2965.txt>

=item \*

L&lt;CGI|CGI&gt; - standard CGI library

=item \*

L&lt;Apache::Session|Apache::Session&gt; - another fine alternative to CGI::Session.

=back

=head1 METHODS

Following is the overview of all the available methods accessible via CGI::Session object.

=head2 new()

=head2 new( $sid )

=head2 new( $query )

=head2 new( $dsn, $query||$sid )

=head2 new( $dsn, $query||$sid, \\%dsn\_args )

Constructor. Returns new session object, or undef on failure. Error message is accessible through L&lt;errstr() - class method|CGI::Session::ErrorHandler/errstr&gt;. If called on an already initialized session will re-initialize the session based on already configured object. This is only useful after a call to L&lt;load()|/"load"&gt;.

Can accept up to three arguments, $dsn - Data Source Name, $query||$sid - query object OR a string representing session id, and finally, \\%dsn\_args, arguments used by $dsn components.

If called without any arguments, $dsn defaults to I&lt;driver:file;serializer:default;id:md5&gt;, $query||$sid defaults to C&lt;&lt; CGI-&gt;new() &gt;&gt;, and C&lt;\\%dsn\_args&gt; defaults to I.

If called with a single argument, it will be treated either as C&lt;$query&gt; object, or C&lt;$sid&gt;, depending on its type. If argument is a string , C&lt;new()&gt; will treat it as session id and will attempt to retrieve the session from data store. If it fails, will create a new session id, which will be accessible through L&lt;id() method|/"id"&gt;. If argument is an object, L&lt;cookie()|CGI/cookie&gt; and L&lt;param()|CGI/param&gt; methods will be called on that object to recover a potential C&lt;$sid&gt; and retrieve it from data store. If it fails, C&lt;new()&gt; will create a new session id, which will be accessible through L&lt;id() method|/"id"&gt;. C&lt;name()&gt; will define the name of the query parameter and/or cookie name to be requested, defaults to I.

If called with two arguments first will be treated as $dsn, and second will be treated as $query or $sid or undef, depending on its type. Some examples of this syntax are:

$s = CGI::Session-&gt;new("driver:mysql", undef); $s = CGI::Session-&gt;new("driver:sqlite", $sid); $s = CGI::Session-&gt;new("driver:db\_file", $query); $s = CGI::Session-&gt;new("serializer:storable;id:incr", $sid); # etc...

Following data source components are supported:

=over 4

=item \*

B - CGI::Session driver. Available drivers are L&lt;file|CGI::Session::Driver::file&gt;, L&lt;db\_file|CGI::Session::Driver::db\_file&gt;, L&lt;mysql|CGI::Session::Driver::mysql&gt; and L&lt;sqlite|CGI::Session::Driver::sqlite&gt;. Third party drivers are welcome. For driver specs consider L&lt;CGI::Session::Driver|CGI::Session::Driver&gt;

=item \*

B - serializer to be used to encode the data structure before saving in the disk. Available serializers are L&lt;storable|CGI::Session::Serialize::storable&gt;, L&lt;freezethaw|CGI::Session::Serialize::freezethaw&gt; and L&lt;default|CGI::Session::Serialize::default&gt;. Default serializer will use L&lt;Data::Dumper|Data::Dumper&gt;.

=item \*

B - ID generator to use when new session is to be created. Available ID generator is L&lt;md5|CGI::Session::ID::md5&gt;

=back

For example, to get CGI::Session store its data using DB\_File and serialize data using [[FreezeThaw]]:

$s = new CGI::Session("driver:DB\_File;serializer:FreezeThaw", undef);

If called with three arguments, first two will be treated as in the previous example, and third argument will be C&lt;\\%dsn\_args&gt;, which will be passed to C&lt;$dsn&gt; components (namely, driver, serializer and id generators) for initialization purposes. Since all the $dsn components must initialize to some default value, this third argument should not be required for most drivers to operate properly.

undef is acceptable as a valid placeholder to any of the above arguments, which will force default behavior.

=head2 load()

=head2 load($query||$sid)

=head2 load($dsn, $query||$sid)

=head2 load($dsn, $query, \\%dsn\_args);

Accepts the same arguments as new(), and also returns a new session object, or undef on failure. The difference is, L&lt;new()|/"new"&gt; can create new session if it detects expired and non-existing sessions, but C&lt;load()&gt; does not.

C&lt;load()&gt; is useful to detect expired or non-existing sessions without forcing the library to create new sessions. So now you can do something like this:

$s = CGI::Session-&gt;load() or die CGI::Session-&gt;errstr(); if ( $s-&gt;is\_expired ) \{ print $s-&gt;header(), $cgi-&gt;start\_html(), $cgi-&gt;p("Your session timed out! Refresh the screen to start new session!") $cgi-&gt;end\_html(); exit(0); \}

if ( $s-&gt;is\_empty ) \{ $s = $s-&gt;new() or die $s-&gt;errstr; \}

Notice, all I sessions are empty, but not all I sessions are expired!

=head2 id()

Returns effective ID for a session. Since effective ID and claimed ID can differ, valid session id should always be retrieved using this method.

=head2 param($name)

=head2 param(-name=E$name)

Used in either of the above syntax returns a session parameter set to $name or undef if it doesn't exist. If it's called on a deleted method param() will issue a warning but return value is not defined.

=head2 param($name, $value)

=head2 param(-name=E$name, -value=E$value)

Used in either of the above syntax assigns a new value to $name parameter, which can later be retrieved with previously introduced param() syntax. C&lt;$value&gt; may be a scalar, arrayref or hashref.

Attempts to set parameter names that start with I will trigger a warning and undef will be returned.

=head2 param\_hashref()

B. Use L&lt;dataref()|/"dataref"&gt; instead.

=head2 dataref()

Returns reference to session's data table:

$params = $s-&gt;dataref(); $sid = $params-&gt;\{\_SESSION\_ID\}; $name= $params-&gt;\{name\}; # etc...

Useful for having all session data in a hashref, but too risky to update.

=head2 save\_param()

=head2 save\_param($query)

=head2 save\_param($query, \\@list)

Saves query parameters to session object. In other words, it's the same as calling L&lt;param($name, $value)|/"param"&gt; for every single query parameter returned by C&lt;&lt; $query-&gt;param() &gt;&gt;. The first argument, if present, should be either CGI object or any object which can provide param() method. If it's undef, defaults to the return value of L&lt;query()|/"query"&gt;, which returns C&lt;&lt; CGI-&gt;new &gt;&gt;. If second argument is present and is a reference to an array, only those query parameters found in the array will be stored in the session. undef is a valid placeholder for any argument to force default behavior.

=head2 load\_param()

=head2 load\_param($query)

=head2 load\_param($query, \\@list)

Loads session parameters into a query object. The first argument, if present, should be query object, or any other object which can provide param() method. If second argument is present and is a reference to an array, only parameters found in that array will be loaded to the query object.

=head2 clear()

=head2 clear('field')

=head2 clear(\\@list)

Clears parameters from the session object.

With no parameters, all fields are cleared. If passed a single parameter or a reference to an array, only the named parameters are cleared.

=head2 flush()

Synchronizes data in memory with the copy serialized by the driver. Call flush() if you need to access the session from outside the current session object. You should at least call flush() before your program exits.

As a last resort, CGI::Session will automatically call flush for you just before the program terminates or session object goes out of scope. This automatic behavior was the recommended behavior until the 4.x series. Automatic flushing has since proven to be unreliable, and in some cases is now required in places that worked with 3.x. For further details see:

<http://rt.cpan.org/Ticket/Display.html?id=17541> <http://rt.cpan.org/Ticket/Display.html?id=17299>

=head2 atime()

Read-only method. Returns the last access time of the session in seconds from epoch. This time is used internally while auto-expiring sessions and/or session parameters.

=head2 ctime()

Read-only method. Returns the time when the session was first created in seconds from epoch.

=head2 expire()

=head2 expire($time)

=head2 expire($param, $time)

Sets expiration interval relative to L&lt;atime()|/"atime"&gt;.

If used with no arguments, returns the expiration interval if it was ever set. If no expiration was ever set, returns undef. For backwards compatibility, a method named C&lt;etime()&gt; does the same thing.

Second form sets an expiration time. This value is checked when previously stored session is asked to be retrieved, and if its expiration interval has passed, it will be expunged from the disk immediately. Passing 0 cancels expiration.

By using the third syntax you can set the expiration interval for a particular session parameter, say I&lt;~logged-in&gt;. This would cause the library call clear() on the parameter when its time is up. Note it only makes sense to set this value to something I than when the whole session expires. Passing 0 cancels expiration.

All the time values should be given in the form of seconds. Following keywords are also supported for your convenience:

+-----------+---------------+

<table border="1" cellpadding="0" cellspacing="0">
  <tr>
    <td align="center"> alias </td>
    <td align="center"> meaning </td>
  </tr>
</table>

+-----------+---------------+

<table border="1" cellpadding="0" cellspacing="0">
  <tr>
    <td align="center"> s </td>
    <td align="center"> Second </td>
  </tr>
  <tr>
    <td align="center"> m </td>
    <td align="center"> Minute </td>
  </tr>
  <tr>
    <td align="center"> h </td>
    <td align="center"> Hour </td>
  </tr>
  <tr>
    <td align="center"> d </td>
    <td align="center"> Day </td>
  </tr>
  <tr>
    <td align="center"> w </td>
    <td align="center"> Week </td>
  </tr>
  <tr>
    <td align="center"> M </td>
    <td align="center"> Month </td>
  </tr>
  <tr>
    <td align="center"> y </td>
    <td align="center"> Year </td>
  </tr>
</table>

+-----------+---------------+

Examples:

$session-&gt;expire("2h"); # expires in two hours $session-&gt;expire(0); # cancel expiration $session-&gt;expire("~logged-in", "10m"); # expires '~logged-in' parameter after 10 idle minutes

Note: all the expiration times are relative to session's last access time, not to its creation time. To expire a session immediately, call L&lt;delete()|/"delete"&gt;. To expire a specific session parameter immediately, call L&lt;clear([$name])|/"clear"&gt;.

=head2 is\_new()

Returns true only for a brand new session.

=head2 is\_expired()

Tests whether session initialized using L&lt;load()|/"load"&gt; is to be expired. This method works only on sessions initialized with load():

$s = CGI::Session-&gt;load() or die CGI::Session-&gt;errstr; if ( $s-&gt;is\_expired ) \{ die "Your session expired. Please refresh"; \} if ( $s-&gt;is\_empty ) \{ $s = $s-&gt;new() or die $s-&gt;errstr; \}

=head2 is\_empty()

Returns true for sessions that are empty. It's preferred way of testing whether requested session was loaded successfully or not:

$s = CGI::Session-&gt;load($sid); if ( $s-&gt;is\_empty ) \{ $s = $s-&gt;new(); \}

Actually, the above code is nothing but waste. The same effect could've been achieved by saying:

$s = CGI::Session-&gt;new( $sid );

L&lt;is\_empty()|/"is\_empty"&gt; is useful only if you wanted to catch requests for expired sessions, and create new session afterwards. See L&lt;is\_expired()|/"is\_expired"&gt; for an example.

=head2 delete()

Deletes a session from the data store and empties session data from memory, completely, so subsequent read/write requests on the same object will fail. Technically speaking, it will only set object's status to I and will trigger L&lt;flush()|/"flush"&gt;, and flush() will do the actual removal.

=head2 find( \\&amp;code )

=head2 find( $dsn, \\&amp;code )

=head2 find( $dsn, \\&amp;code, \\%dsn\_args )

Experimental feature. Executes \\&amp;code for every session object stored in disk, passing initialized CGI::Session object as the first argument of \\&amp;code. Useful for housekeeping purposes, such as for removing expired sessions. Following line, for instance, will remove sessions already expired, but are still in disk:

The following line, for instance, will remove sessions already expired, but which are still on disk:

CGI::Session-&gt;find( sub \{\} );

Notice, above \\&amp;code didn't have to do anything, because load(), which is called to initialize sessions inside find(), will automatically remove expired sessions. Following example will remove all the objects that are 10+ days old:

CGI::Session-&gt;find( \\&amp;purge ); sub purge \{ my ($session) = @\_; next if $session-&gt;is\_empty; # &lt;-- already expired?! if ( ($session-&gt;ctime + 3600\*240) &lt;= time() ) \{ $session-&gt;delete() or warn "couldn't remove " . $session-&gt;id . ": " . $session-&gt;errstr; \} \}

B: find will not change the modification or access times on the sessions it returns.

Explanation of the 3 parameters to C&lt;find()&gt;:

=over 4

=item $dsn

This is the DSN (Data Source Name) used by CGI::Session to control what type of sessions you previously created and what type of sessions you now wish method C&lt;find()&gt; to pass to your callback.

The default value is defined above, in the docs for method C&lt;new()&gt;, and is 'driver:file;serializer:default;id:md5'.

Do not confuse this DSN with the DSN arguments mentioned just below, under \\%dsn\_args.

=item \\&amp;code

This is the callback provided by you (i.e. the caller of method C&lt;find()&gt;) which is called by CGI::Session once for each session found by method C&lt;find()&gt; which matches the given $dsn.

There is no default value for this coderef.

When your callback is actually called, the only parameter is a session. If you want to call a subroutine you already have with more parameters, you can achieve this by creating an anonymous subroutine that calls your subroutine with the parameters you want. For example:

CGI::Session-&gt;find($dsn, sub \{ my\_subroutine( @\_, 'param 1', 'param 2' ) \} ); CGI::Session-&gt;find($dsn, sub \{ $coderef-&gt;( @\_, $extra\_arg ) \} );

Or if you wish, you can define a sub generator as such:

sub coderef\_with\_args \{ my ( $coderef, @params ) = @\_; return sub \{ $coderef-&gt;( @\_, @params ) \}; \}

CGI::Session-&gt;find($dsn, coderef\_with\_args( $coderef, 'param 1', 'param 2' ) );

=item \\%dsn\_args

If your $dsn uses file-based storage, then this hashref might contain keys such as:

\{ Directory =&gt; Value 1, [[NoFlock]] =&gt; Value 2, UMask =&gt; Value 3 \}

If your $dsn uses db-based storage, then this hashref contains (up to) 3 keys, and looks like:

\{ [[DataSource]] =&gt; Value 1, User =&gt; Value 2, Password =&gt; Value 3 \}

These 3 form the DSN, username and password used by DBI to control access to your database server, and hence are only relevant when using db-based sessions.

The default value of this hashref is undef.

=back

B&lt;Note:&gt; find() is meant to be convenient, not necessarily efficient. It's best suited in cron scripts.

=head1 MISCELLANEOUS METHODS

=head2 remote\_addr()

Returns the remote address of the user who created the session for the first time. Returns undef if variable REMOTE\_ADDR wasn't present in the environment when the session was created.

=head2 errstr()

Class method. Returns last error message from the library.

=head2 dump()

Returns a dump of the session object. Useful for debugging purposes only.

=head2 header()

Replacement for L&lt;CGI.pm|CGI&gt;'s header() method. Without this method, you usually need to create a CGI::Cookie object and send it as part of the HTTP header:

$cookie = CGI::Cookie-&gt;new(-name=&gt;$session-&gt;name, -value=&gt;$session-&gt;id); print $cgi-&gt;header(-cookie=&gt;$cookie);

You can minimize the above into:

print $session-&gt;header();

It will retrieve the name of the session cookie from C&lt;$session-&gt;name()&gt; which defaults to C&lt;$CGI::Session::NAME&gt;. If you want to use a different name for your session cookie, do something like following before creating session object:

CGI::Session-&gt;name("MY\_SID"); $session = new CGI::Session(undef, $cgi, \\%attrs);

Now, $session-&gt;header() uses "MY\_SID" as a name for the session cookie.

=head2 query()

Returns query object associated with current session object. Default query object class is L&lt;CGI.pm|CGI&gt;.

=head2 DEPRECATED METHODS

These methods exist solely for for compatibility with CGI::Session 3.x.

=head3 close()

Closes the session. Using flush() is recommended instead, since that's exactly what a call to close() does now.

=head1 DISTRIBUTION

CGI::Session consists of several components such as L&lt;drivers|"DRIVERS"&gt;, L&lt;serializers|"SERIALIZERS"&gt; and L. This section lists what is available.

=head2 DRIVERS

Following drivers are included in the standard distribution:

=over 4

=item \*

L&lt;file|CGI::Session::Driver::file&gt; - default driver for storing session data in plain files. Full name: B&lt;CGI::Session::Driver::file&gt;

=item \*

L&lt;db\_file|CGI::Session::Driver::db\_file&gt; - for storing session data in [[BerkelyDB]]. Requires: L. Full name: B&lt;CGI::Session::Driver::db\_file&gt;

=item \*

L&lt;mysql|CGI::Session::Driver::mysql&gt; - for storing session data in [[MySQL]] tables. Requires L&lt;DBI|DBI&gt; and L&lt;DBD::mysql|DBD::mysql&gt;. Full name: B&lt;CGI::Session::Driver::mysql&gt;

=item \*

L&lt;sqlite|CGI::Session::Driver::sqlite&gt; - for storing session data in SQLite. Requires L&lt;DBI|DBI&gt; and L&lt;DBD::SQLite|DBD::SQLite&gt;. Full name: B&lt;CGI::Session::Driver::sqlite&gt;

=back

=head2 SERIALIZERS

=over 4

=item \*

L&lt;default|CGI::Session::Serialize::default&gt; - default data serializer. Uses standard L&lt;Data::Dumper|Data::Dumper&gt;. Full name: B&lt;CGI::Session::Serialize::default&gt;.

=item \*

L&lt;storable|CGI::Session::Serialize::storable&gt; - serializes data using L. Requires L. Full name: B&lt;CGI::Session::Serialize::storable&gt;.

=item \*

L&lt;freezethaw|CGI::Session::Serialize::freezethaw&gt; - serializes data using L. Requires L. Full name: B&lt;CGI::Session::Serialize::freezethaw&gt;

=item \*

L&lt;yaml|CGI::Session::Serialize::yaml&gt; - serializes data using YAML. Requires L or L&lt;YAML::Syck&gt;. Full name: B&lt;CGI::Session::Serialize::yaml&gt;

=item \*

L&lt;json|CGI::Session::Serialize::json&gt; - serializes data using JSON. Requires L&lt;JSON::Syck&gt;. Full name: B&lt;CGI::Session::Serialize::json&gt;

=back

=head2 ID GENERATORS

Following ID generators are available:

=over 4

=item \*

L&lt;md5|CGI::Session::ID::md5&gt; - generates 32 character long hexadecimal string. Requires L&lt;Digest::MD5|Digest::MD5&gt;. Full name: B&lt;CGI::Session::ID::md5&gt;.

=item \*

L&lt;incr|CGI::Session::ID::incr&gt; - generates incremental session ids.

=item \*

L&lt;static|CGI::Session::ID::static&gt; - generates static session ids. B&lt;CGI::Session::ID::static&gt;

=back

=head1 CREDITS

CGI::Session evolved to what it is today with the help of following developers. The list doesn't follow any strict order, but somewhat chronological. Specifics can be found in F file

=over 4

=item Andy Lester

=item Brian King Emrbbking@mac.comE

=item Olivier Dragon Edragon@shadnet.shad.caE

=item Adam Jacob Eadam@sysadminsith.orgE

=item Igor Plisco Eigor@plisco.ruE

=item Mark Stosberg

=item Matt [[LeBlanc]] Emleblanc@cpan.orgE

=item Shawn Sorichetti

=back

=head1 COPYRIGHT

Copyright (C) 2001-2005 Sherzod Ruzmetov Esherzodr@cpan.orgE. All rights reserved. This library is free software. You can modify and or distribute it under the same terms as Perl itself.

=head1 PUBLIC CODE REPOSITORY

You can see what the developers have been up to since the last release by checking out the code repository. You can browse the Subversion repository from here:

<http://svn.cromedome.net/>

Or check it directly with C from here:

svn://svn.cromedome.net/CGI-Session

=head1 SUPPORT

If you need help using CGI::Session consider the mailing list. You can ask the list by sending your questions to <cgi-session-user@lists.sourceforge.net> .

You can subscribe to the mailing list at <https://lists.sourceforge.net/lists/listinfo/cgi-session-user> .

Bug reports can be submitted at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CGI-Session>

=head1 AUTHOR

Sherzod Ruzmetov Esherzodr@cpan.orgE, <http://author.handalak.com/>

Mark Stosberg became a co-maintainer during the development of 4.0. C&lt;markstos@cpan.org&gt;.

=head1 SEE ALSO

=over 4

=item \*

L&lt;CGI::Session::Tutorial|CGI::Session::Tutorial&gt; - extended CGI::Session manual

=item \*

B - "HTTP State Management Mechanism" found at <ftp://ftp.isi.edu/in-notes/rfc2965.txt>

=item \*

L&lt;CGI|CGI&gt; - standard CGI library

=item \*

L&lt;Apache::Session|Apache::Session&gt; - another fine alternative to CGI::Session

=back