.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Sympa::WWW::Session 3Sympa" .TH Sympa::WWW::Session 3Sympa "2020-12-30" "6.2.58" "sympa 6.2.58" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Sympa::WWW::Session \- Web session .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Sympa::WWW::Session; \& \& my $session = Sympa::WWW::Session\->new($robot, \& {cookie => Sympa::WWW::Session::get_session_cookie($ENV{\*(AqHTTP_COOKIE\*(Aq})} \& ); \& $session\->renew(); \& $session\->store(); .Ve .SS "Confirmation" .IX Subsection "Confirmation" .Vb 1 \& $session\->confirm_action($action, \*(Aqinit\*(Aq); \& \& sub do_myaction { \& \& # Validate arguments... \& \& $param\->{arg} = $arg; \& my $next_action = $session\->confirm_action($action, $response, \& $arg, $previous_action); \& return $next_action unless $next_action eq \*(Aq1\*(Aq; \& \& # Process action... \& \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Sympa::WWW::Session provides web session for Sympa web interface. \&\s-1HTTP\s0 cookie is required to determine users. Session store is used to keep users' personal data. .SS "Methods" .IX Subsection "Methods" .ie n .IP "new ( $robot, { [ cookie => $cookie ], ... } )" 4 .el .IP "new ( \f(CW$robot\fR, { [ cookie => \f(CW$cookie\fR ], ... } )" 4 .IX Item "new ( $robot, { [ cookie => $cookie ], ... } )" \&\fIConstructor\fR. Creates new instance and loads user data from session store. .Sp Parameters: .RS 4 .ie n .IP "$robot" 4 .el .IP "\f(CW$robot\fR" 4 .IX Item "$robot" Context of the session. .ie n .IP "{ cookie => $cookie }" 4 .el .IP "{ cookie => \f(CW$cookie\fR }" 4 .IX Item "{ cookie => $cookie }" \&\s-1HTTP\s0 cookie. .RE .RS 4 .Sp Returns: .Sp A new instance. .RE .IP "as_hashref ( )" 4 .IX Item "as_hashref ( )" \&\fIInstance method\fR. Casts the instance to hashref. .Sp Parameters: .Sp None. .Sp Returns: .Sp A hashref including attributes of instance (see \*(L"Attributes\*(R"). .ie n .IP "confirm_action ( $action, $response, [ arg => $arg, ] [ previous_action => $previous_action ] )" 4 .el .IP "confirm_action ( \f(CW$action\fR, \f(CW$response\fR, [ arg => \f(CW$arg\fR, ] [ previous_action => \f(CW$previous_action\fR ] )" 4 .IX Item "confirm_action ( $action, $response, [ arg => $arg, ] [ previous_action => $previous_action ] )" \&\fIInstance method\fR. Check if action has been confirmed. .Sp Confirmation follows two steps: .RS 4 .IP "1." 4 The method is called with no (undefined) response. The action, hash of argument and previous_action are stored into session store. And then this method returns \f(CW\*(Aqconfirm_action\*(Aq\fR. .IP "2." 4 The method is called with \f(CW\*(Aqconfirm\*(Aq\fR or other true value as response. \&\fIIf\fR action and hash of argument match with those in session store, and: .RS 4 .IP "\(bu" 4 If \f(CW\*(Aqconfirm\*(Aq\fR is given, returns \f(CW1\fR. .IP "\(bu" 4 If other true value is given, returns previous action stored in session store (previous_action given in argument is ignored). .RE .RS 4 .Sp In both cases session store is cleared. .RE .RE .RS 4 .Sp Anytime when the action submitted by user is determined, This method may be called with response as \f(CW\*(Aqinit\*(Aq\fR. In this case, if action doesn't match with that in session store, session store will be cleared. .Sp Parameters: .ie n .IP "$action" 4 .el .IP "\f(CW$action\fR" 4 .IX Item "$action" Action to be checked. .ie n .IP "$response" 4 .el .IP "\f(CW$response\fR" 4 .IX Item "$response" Response from user: \&\f(CW\*(Aqinit\*(Aq\fR, false value (not yet checked), \f(CW\*(Aqconfirm\*(Aq\fR and others (cancelled). This may typically be given by user using \f(CW\*(C`response_action\*(C'\fR parameter. .ie n .IP "arg => $arg" 4 .el .IP "arg => \f(CW$arg\fR" 4 .IX Item "arg => $arg" Argument(s) of action. .ie n .IP "previous_action => $previous_action" 4 .el .IP "previous_action => \f(CW$previous_action\fR" 4 .IX Item "previous_action => $previous_action" The action users will be redirected when action is confirmed. This may typically given by user using \f(CW\*(C`previous_action\*(C'\fR parameter. .RE .RS 4 .RE .IP "is_anonymous ( )" 4 .IX Item "is_anonymous ( )" \&\fIInstance method\fR. \&\s-1TBD.\s0 .IP "renew ( )" 4 .IX Item "renew ( )" \&\fIInstance method\fR. Renews the session. Updates internal session \s-1ID\s0 and \s-1HTTP\s0 cookie. .IP "store ( )" 4 .IX Item "store ( )" \&\fIInstance method\fR. Stores session into session store. .SS "Functions" .IX Subsection "Functions" .IP "check_cookie_extern ( )" 4 .IX Item "check_cookie_extern ( )" \&\fIFunction\fR. Deprecated. .IP "decrypt_session_id ( )" 4 .IX Item "decrypt_session_id ( )" \&\fIFunction\fR. Deprecated. .IP "encrypt_session_id ( )" 4 .IX Item "encrypt_session_id ( )" \&\fIFunction\fR. Deprecated. .IP "list_sessions ( )" 4 .IX Item "list_sessions ( )" \&\fIFunction\fR. \&\s-1TBD.\s0 .IP "purge_old_sessions ( )" 4 .IX Item "purge_old_sessions ( )" \&\fIFunction\fR. Deprecated. .ie n .IP "set_cookie ( $cookie_domain, $expires, [ $use_ssl ] )" 4 .el .IP "set_cookie ( \f(CW$cookie_domain\fR, \f(CW$expires\fR, [ \f(CW$use_ssl\fR ] )" 4 .IX Item "set_cookie ( $cookie_domain, $expires, [ $use_ssl ] )" \&\fIInstance method\fR. \&\s-1TBD.\s0 .ie n .IP "set_cookie_extern ( $cookie_domain, [ $use_ssl ] )" 4 .el .IP "set_cookie_extern ( \f(CW$cookie_domain\fR, [ \f(CW$use_ssl\fR ] )" 4 .IX Item "set_cookie_extern ( $cookie_domain, [ $use_ssl ] )" \&\fIInstance method\fR. Deprecated. .SS "Attributes" .IX Subsection "Attributes" \&\s-1TBD.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" Sympa::DatabaseManager. .SH "HISTORY" .IX Header "HISTORY" SympaSession appeared on Sympa 5.4a3. .PP It was renamed to Sympa::Session on Sympa 6.2a.41, then Sympa::WWW::Session on Sympa 6.2.26. .PP \&\*(L"confirm_action\*(R" method was added on Sympa 6.2.17.