Annotation of loncom/auth/lonlogout.pm, revision 1.59
1.1 www 1: # The LearningOnline Network
2: # Logout Handler
1.3 www 3: #
1.59 ! raeburn 4: # $Id: lonlogout.pm,v 1.58 2022/05/24 16:23:04 raeburn Exp $
1.3 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 www 28:
1.36 jms 29: =head1 NAME
30:
31: Apache::lonlogout
32:
33: =head1 SYNOPSIS
34:
35:
36: This is part of the LearningOnline Network with CAPA project
37: described at http://www.lon-capa.org.
38:
39:
40: =cut
41:
1.1 www 42: package Apache::lonlogout;
43:
44: use strict;
45: use Apache::Constants qw(:common);
46: use Apache::File;
47: use Apache::lonnet;
1.51 raeburn 48: use Apache::loncommon;
1.2 www 49: use Apache::lonmenu;
1.1 www 50: use CGI::Cookie();
1.11 www 51: use Apache::lonlocal;
1.52 raeburn 52: use LONCAPA qw(:DEFAULT :match);
1.1 www 53:
54: sub handler {
55: my $r = shift;
56:
1.17 albertel 57: #Check for cookie
1.1 www 58: my $requrl=$r->uri;
1.29 albertel 59: my $handle = &Apache::lonnet::check_for_valid_session($r);
1.17 albertel 60: #check if cookie still valid
1.29 albertel 61: if ($handle eq '') {
1.17 albertel 62: $r->log_reason("Cookie $handle not valid", $r->filename);
63: return FORBIDDEN;
64: }
65:
66: #we've got a valid user
1.31 www 67: #any locks in place?
68: my $locknum=&Apache::lonnet::get_locks();
69: if ($locknum) { return 409; }
70: #nope, go ahead
1.17 albertel 71: my @profile;
1.29 albertel 72: my $lonidsdir=$r->dir_config('lonIDsDir');
1.21 albertel 73: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
1.55 raeburn 74: if (unlink("$lonidsdir/$handle.id")) {
75: if (($env{'user.linkedenv'} =~ /^[a-f0-9]+_linked$/) &&
76: (-l "$lonidsdir/$env{'user.linkedenv'}.id") &&
77: (readlink("$lonidsdir/$env{'user.linkedenv'}.id") eq "$lonidsdir/$handle.id")) {
78: unlink("$lonidsdir/$env{'user.linkedenv'}.id");
1.50 raeburn 79: }
80: }
1.46 raeburn 81: if (!$Apache::lonlocal::lh) {
82: &Apache::lonlocal::get_language_handle($r);
83: }
1.17 albertel 84: my %temp=('logout' => time);
1.57 raeburn 85: my $ip = &Apache::lonnet::get_requestor_ip();
1.17 albertel 86: &Apache::lonnet::put('email_status',\%temp);
1.21 albertel 87: &Apache::lonnet::log($env{'user.domain'},
88: $env{'user.name'},
89: $env{'user.home'},
1.57 raeburn 90: "Logout $ip");
1.25 albertel 91:
1.17 albertel 92: &Apache::loncommon::content_type($r,'text/html');
1.25 albertel 93:
1.55 raeburn 94: #expire the cookies
95: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
96: foreach my $name (keys(%cookies)) {
97: next unless ($name =~ /^lon(|S|Link|Pub)ID$/);
98: my $c = new CGI::Cookie(-name => $name,
99: -value => '',
100: -expires => '-10y',);
101: $r->headers_out->add('Set-cookie' => $c);
1.50 raeburn 102: }
1.17 albertel 103: $r->send_http_header;
104: return OK if $r->header_only;
1.2 www 105: # -------------------------------------------------------- Menu script and info
106:
1.6 www 107: # ---------------------------------------------------------------- Get handover
108: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['handover']);
109: my $switch='';
1.18 albertel 110: my $start_page='';
1.7 www 111: my $relogmessage='';
1.14 albertel 112: if ($env{'form.handover'}) {
1.17 albertel 113: $switch='<meta HTTP-EQUIV="Refresh" CONTENT="0.5; url='.
1.37 bisitz 114: $env{'form.handover'}.'" />';
1.17 albertel 115: $start_page=&Apache::loncommon::start_page('Switching Server ...',
116: $switch);
117: } else {
1.47 raeburn 118: my $domain = $env{'user.domain'};
1.51 raeburn 119: my ($headextra,$ssofile);
120: if ($env{'request.sso.login'}) {
121: my $londocroot = $r->dir_config('lonDocRoot');
122: if ($domain =~ /^$match_domain$/) {
123: if (defined($r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
124: $ssofile = '/'.&Apache::loncommon::clean_path($r->dir_config("lonSSOUserLogoutHeadFile_$domain"));
125: if ($ssofile eq $r->dir_config("lonSSOUserLogoutHeadFile_$domain")) {
126: if ($ssofile =~ /^\Q$londocroot\E/) {
1.53 raeburn 127: if (open(my $fh,'<',$ssofile)) {
1.51 raeburn 128: $headextra = join('',<$fh>);
129: close($fh);
130: }
131: }
132: }
133: }
134: }
135: if (defined($r->dir_config('lonSSOUserLogoutHeadFile'))) {
136: $ssofile = '/'.&Apache::loncommon::clean_path($r->dir_config('lonSSOUserLogoutHeadFile'));
137: if ($ssofile eq $r->dir_config('lonSSOUserLogoutHeadFile')) {
138: if ($ssofile =~ /^\Q$londocroot\E/) {
1.53 raeburn 139: if (open(my $fh,'<',$ssofile)) {
1.51 raeburn 140: $headextra.= join('',<$fh>);
141: close($fh);
142: }
143: }
144: }
1.47 raeburn 145: }
146: }
147: $start_page=&Apache::loncommon::start_page('Logged Out',$headextra,
1.41 droeschl 148: {'no_nav_bar' => 1,});
1.26 albertel 149:
1.32 bisitz 150: $relogmessage.='<h1>'.&mt('Goodbye').'</h1>'
151: .'<p>'.&mt('Thank you for using LON-CAPA.').'</p>';
1.26 albertel 152:
153: if (!$env{'request.sso.norelogin'}) {
1.42 raeburn 154: my ($relogin_server,$login_url);
1.26 albertel 155: if ($env{'request.sso.reloginserver'}) {
156: $relogin_server = $env{'request.sso.reloginserver'};
1.42 raeburn 157: } else {
158: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
159: if ($domdefaults{'portal_def'}) {
160: $login_url = $domdefaults{'portal_def'};
161: } else {
162: my $checkloginvia = 1;
1.44 raeburn 163: my ($lonhost,$server,$path,$isredirect) =
1.42 raeburn 164: &Apache::lonnet::choose_server($domain,$checkloginvia);
165: if ($server && $lonhost) {
166: $login_url = $Apache::lonnet::protocol{$lonhost}.
167: '://'.$server.$path;
1.44 raeburn 168: if (($path eq '') && (!$isredirect)) {
169: my $serverhomeID =
1.45 raeburn 170: &Apache::lonnet::get_server_homeID($server);
1.44 raeburn 171: my $serverhomedom =
172: &Apache::lonnet::host_domain($serverhomeID);
173: if ($serverhomedom ne $domain) {
174: $path = '/adm/login';
175: $login_url .= $path;
176: }
177: }
1.43 raeburn 178: if ($path eq '/adm/login' && $domain ne '') {
179: $login_url .= '?domain='.$domain;
180: }
1.42 raeburn 181: }
182: }
183: }
184: if ($login_url eq '') {
185: $login_url = $relogin_server.'/adm/'.
186: ($env{'request.sso.login'} ? 'roles': 'login?domain='.$domain);
187: }
1.54 raeburn 188: $relogmessage.='<p>'.&mt('You have been successfully logged out.');
1.58 raeburn 189: unless ((($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) ||
190: (($env{'request.deeplink.login'}) && ($env{'request.deeplink.target'} eq '_self'))) {
1.54 raeburn 191: $relogmessage.=' '.&mt('You can [_1]close this window[_2] now.',
192: '',''); # ,'<a href="javascript:self.close();">','</a>');
193: }
194: $relogmessage.='</p>';
1.33 jms 195: =pod
196:
197: =head1 NOTES:
198:
1.34 bisitz 199: '<a href="javascript:self.close();">','</a>'
1.33 jms 200:
1.49 raeburn 201: Due to security reasons in new web browsers a window could only be closed with javascript, if this window has also been opened with javascript. This is not done here which means that in most cases the close link will not work. Unless we find another solution, this link should not be offered. (Stefan Bisitz, 2008-08-01)
1.33 jms 202:
203: =cut
1.59 ! raeburn 204: unless (($env{'request.lti.login'}) || ($env{'request.deeplink.login'})) {
1.54 raeburn 205: $relogmessage.='<p>'.&mt('[_1]Log in again[_2]'
206: ,'<a href="'.$login_url.'">','</a>')
207: .'</p>';
208: }
1.26 albertel 209: }
1.20 albertel 210: if ($env{'request.sso.login'}
1.26 albertel 211: && defined($r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.53 raeburn 212: if (open(my $fh,'<',$r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.47 raeburn 213: $relogmessage.= join('',<$fh>);
214: close($fh);
215: }
1.26 albertel 216: }
217: if ($env{'request.sso.login'}
1.27 albertel 218: && defined($r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.53 raeburn 219: if (open(my $fh,'<',$r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.47 raeburn 220: $relogmessage.= join('',<$fh>);
221: close($fh);
222: }
1.20 albertel 223: }
1.17 albertel 224: }
1.18 albertel 225: my $end_page=&Apache::loncommon::end_page();
1.2 www 226: # --------------------------------------------------------------- Screen Output
1.17 albertel 227: $r->print(<<ENDDOCUMENT);
1.16 albertel 228: $start_page
1.7 www 229: $relogmessage
1.16 albertel 230: $end_page
1.1 www 231: ENDDOCUMENT
1.56 raeburn 232: if ($env{'request.balancercookie'}) {
233: my ($balancer,$cookie) = split(/:/,$env{'request.balancercookie'});
234: if ((&Apache::lonnet::hostname($balancer)) && ($cookie =~ /^[a-f0-9]{32}$/)) {
235: $cookie = $env{'user.domain'}.'_'.$env{'user.name'}.'_'.$cookie;
236: &Apache::lonnet::delbalcookie($cookie,$balancer);
237: }
238: }
1.28 albertel 239: $r->register_cleanup(\&flush_course_logs);
240: return OK;
241: }
242:
243: sub flush_course_logs {
1.17 albertel 244: &Apache::lonnet::flushcourselogs();
1.28 albertel 245: return OK;
1.1 www 246: }
247:
248: 1;
249: __END__
250:
251:
252:
253:
254:
255:
256:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonlogout.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / auth